Configuration Properties ReferencePDF version

Data Analytics Studio Properties in Cloudera Runtime 7.1.7

Role groups:

Description
For advanced use only. A string to be inserted into conf/props/eventprocessor.properties for this role only.
Related Name
Default Value
API Name
conf/props/eventprocessor.properties_role_safety_valve
Required
false
Description
For advanced use only. A string to be inserted into conf/props/eventprocessor_extra.properties for this role only.
Related Name
Default Value
API Name
conf/props/eventprocessor_extra.properties_role_safety_valve
Required
false
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
DAS_EVENT_PROCESSOR_role_env_safety_valve
Required
false
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
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
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
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
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
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
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
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

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
das_event_processor_fd_thresholds
Required
false
Description
When computing the overall Data Analytics Studio Eventprocessor health, consider the host's health.
Related Name
Default Value
true
API Name
das_event_processor_host_health_enabled
Required
false
Description
Enables the health test that the Data Analytics Studio Eventprocessor's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
das_event_processor_scm_health_enabled
Required
false
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
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
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
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
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.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the 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
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
Related Name
Default Value
API Name
monitoring_metric_filter
Required
false
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
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
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
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.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health: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
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
Description
The period to review when computing unexpected exits.
Related Name
Default Value
5 minute(s)
API Name
unexpected_exits_window
Required
false

Description
These arguments are passed as part of the Java command line. Commonly, garbage collection flags and/or extra debugging flags are set here.
Related Name
das_eventprocessor_java_opts
Default Value
-Xmx4096m
API Name
das_eventprocessor_java_opts
Required
false
Description
Extra classpath arguments for eventprocessor.
Related Name
data_analytics_studio_ep_additional_classpath
Default Value
API Name
data_analytics_studio_ep_additional_classpath
Required
false

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

Description
Port for eventprocessor admin endpoint
Related Name
data_analytics_studio_event_processor_admin_server_port
Default Value
30901
API Name
data_analytics_studio_event_processor_admin_server_port
Required
true
Description
Port to eventprocessor server
Related Name
data_analytics_studio_event_processor_server_port
Default Value
30900
API Name
data_analytics_studio_event_processor_server_port
Required
true

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
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
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
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
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

Description
The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Data Analytics Studio Eventprocessor 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
das.eventprocessor.ssl.truststore.location
Default Value
API Name
ssl_client_truststore_location
Required
false
Description
The password for the Data Analytics Studio Eventprocessor 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
das.eventprocessor.ssl.truststore.password
Default Value
API Name
ssl_client_truststore_password
Required
false
Description
Encrypt communication between clients and Data Analytics Studio Eventprocessor using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name
data_analytics_studio_event_processor_ssl_enabled
Default Value
false
API Name
ssl_enabled
Required
false
Description
The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Data Analytics Studio Eventprocessor is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name
data_analytics_studio_event_processor_keystore_file
Default Value
API Name
ssl_server_keystore_location
Required
false
Description
The password for the Data Analytics Studio Eventprocessor keystore file.
Related Name
das_event_processor_keystore_password
Default Value
API Name
ssl_server_keystore_password
Required
false

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
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
Description
Whether or not periodic stacks collection is enabled.
Related Name
stacks_collection_enabled
Default Value
false
API Name
stacks_collection_enabled
Required
true
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
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

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
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Eventprocessor Advanced Configuration Snippet (Safety Valve) for conf/props/eventprocessor.properties parameter.
Related Name
Default Value
false
API Name
role_config_suppression_conf/props/eventprocessor.properties_role_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Eventprocessor Advanced Configuration Snippet (Safety Valve) for conf/props/eventprocessor_extra.properties parameter.
Related Name
Default Value
false
API Name
role_config_suppression_conf/props/eventprocessor_extra.properties_role_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Eventprocessor Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_event_processor_role_env_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Additional Eventprocessor Java Options parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_eventprocessor_java_opts
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Additional Eventprocessor Classpath parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_ep_additional_classpath
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the DAS Eventprocessor Admin Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_event_processor_admin_server_port
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the DAS Eventprocessor Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_event_processor_server_port
Required
true
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
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
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
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Eventprocessor TLS/SSL Trust Store File parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_location
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Eventprocessor TLS/SSL Trust Store Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_password
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Eventprocessor TLS/SSL Server Keystore File Location parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_location
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Eventprocessor TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_password
Required
true
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
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_das_das_event_processor_audit_health
Required
true
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_das_das_event_processor_file_descriptor
Required
true
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_das_das_event_processor_host_health
Required
true
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_das_das_event_processor_log_directory_free_space
Required
true
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_das_das_event_processor_scm_health
Required
true
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_das_das_event_processor_swap_memory_usage
Required
true
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_das_das_event_processor_swap_memory_usage_rate
Required
true
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_das_das_event_processor_unexpected_exits
Required
true

Description
For advanced use only. A string to be inserted into conf/props/webapp.properties for this role only.
Related Name
Default Value
API Name
conf/props/webapp.properties_role_safety_valve
Required
false
Description
For advanced use only. A string to be inserted into conf/ranger-hive-audit.xml for this role only.
Related Name
Default Value
API Name
conf/ranger-hive-audit.xml_role_safety_valve
Required
false
Description
For advanced use only. A string to be inserted into conf/ranger-hive-policymgr-ssl.xml for this role only.
Related Name
Default Value
API Name
conf/ranger-hive-policymgr-ssl.xml_role_safety_valve
Required
false
Description
For advanced use only. A string to be inserted into conf/ranger-hive-security.xml for this role only.
Related Name
Default Value
API Name
conf/ranger-hive-security.xml_role_safety_valve
Required
false
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
DAS_WEBAPP_role_env_safety_valve
Required
false
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
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
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
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
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
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
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
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

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
das_webapp_fd_thresholds
Required
false
Description
When computing the overall Data Analytics Studio Webapp Server health, consider the host's health.
Related Name
Default Value
true
API Name
das_webapp_host_health_enabled
Required
false
Description
Enables the health test that the Data Analytics Studio Webapp Server's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
das_webapp_scm_health_enabled
Required
false
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
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
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
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
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.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the 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
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
Related Name
Default Value
API Name
monitoring_metric_filter
Required
false
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
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
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
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.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health: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
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
Description
The period to review when computing unexpected exits.
Related Name
Default Value
5 minute(s)
API Name
unexpected_exits_window
Required
false

Description
These arguments are passed as part of the Java command line. Commonly, garbage collection flags and/or extra debugging flags are set here.
Related Name
das_webapp_java_opts
Default Value
-Xmx4096m
API Name
das_webapp_java_opts
Required
false
Description
LDAP basedn
Related Name
das_webapp_ldap_basedn
Default Value
API Name
das_webapp_ldap_basedn
Required
false
Description
LDAP custom query
Related Name
das_webapp_ldap_custom_ldap_query
Default Value
API Name
das_webapp_ldap_custom_ldap_query
Required
false
Description
LDAP domain
Related Name
das_webapp_ldap_domain
Default Value
API Name
das_webapp_ldap_domain
Required
false
Description
LDAP group class key
Related Name
das_webapp_ldap_group_class_key
Default Value
API Name
das_webapp_ldap_group_class_key
Required
false
Description
LDAP group DN pattern
Related Name
das_webapp_ldap_group_dn_pattern
Default Value
API Name
das_webapp_ldap_group_dn_pattern
Required
false
Description
LDAP group filter
Related Name
das_webapp_ldap_group_filter
Default Value
API Name
das_webapp_ldap_group_filter
Required
false
Description
LDAP group membership key
Related Name
das_webapp_ldap_group_membership_key
Default Value
API Name
das_webapp_ldap_group_membership_key
Required
false
Description
Knox LDAP GUID key
Related Name
das_webapp_ldap_guid_key
Default Value
API Name
das_webapp_ldap_guid_key
Required
false
Description
Knox LDAP URL
Related Name
das_webapp_ldap_url
Default Value
API Name
das_webapp_ldap_url
Required
false
Description
LDAP user DN pattern
Related Name
das_webapp_ldap_user_dn_pattern
Default Value
API Name
das_webapp_ldap_user_dn_pattern
Required
false
Description
LDAP user filter
Related Name
das_webapp_ldap_user_filter
Default Value
API Name
das_webapp_ldap_user_filter
Required
false
Description
LDAP user membership key
Related Name
das_webapp_ldap_user_membership_key
Default Value
API Name
das_webapp_ldap_user_membership_key
Required
false
Description
List of comma seperator users who should have admin privileges.
Related Name
data_analytics_studio_admin_users
Default Value
API Name
data_analytics_studio_admin_users
Required
false
Description
DAS user authentication
Related Name
data_analytics_studio_user_authentication
Default Value
NONE
API Name
data_analytics_studio_user_authentication
Required
false
Description
Additional Webapp classpath
Related Name
data_analytics_studio_webapp_additional_classpath
Default Value
API Name
data_analytics_studio_webapp_additional_classpath
Required
false
Description
Knox proxy doAs param name
Related Name
data_analytics_studio_webapp_doas_param_name
Default Value
doAs
API Name
data_analytics_studio_webapp_doas_param_name
Required
false
Description
Knox JWT cookie name
Related Name
data_analytics_studio_webapp_knox_cookiename
Default Value
hadoop-jwt
API Name
data_analytics_studio_webapp_knox_cookiename
Required
false
Description
Knox JWT Cookie public key
Related Name
data_analytics_studio_webapp_knox_publickey
Default Value
API Name
data_analytics_studio_webapp_knox_publickey
Required
false
Description
Knox SSO endpoint
Related Name
data_analytics_studio_webapp_knox_sso_url
Default Value
API Name
data_analytics_studio_webapp_knox_sso_url
Required
false
Description
Knox logout endpoint
Related Name
data_analytics_studio_webapp_knox_ssout_url
Default Value
API Name
data_analytics_studio_webapp_knox_ssout_url
Required
false
Description
Knox redirect url param
Related Name
data_analytics_studio_webapp_knox_url_query_param
Default Value
originalUrl
API Name
data_analytics_studio_webapp_knox_url_query_param
Required
false
Description
Knox SPNEGO user
Related Name
data_analytics_studio_webapp_knox_user
Default Value
knox
API Name
data_analytics_studio_webapp_knox_user
Required
false
Description
Knox useragent
Related Name
data_analytics_studio_webapp_knox_useragent
Default Value
Mozilla, Chrome
API Name
data_analytics_studio_webapp_knox_useragent
Required
false
Description
The user session timeout in seconds.
Related Name
data_analytics_studio_webapp_session_timeout
Default Value
1 day(s)
API Name
data_analytics_studio_webapp_session_timeout
Required
false
Description
Knox SPNEGO name rules
Related Name
data_analytics_studio_webapp_spnego_name_rules
Default Value
API Name
data_analytics_studio_webapp_spnego_name_rules
Required
false
Description
Spool directory for Ranger audits being written to DFS.
Related Name
xasecure.audit.destination.hdfs.batch.filespool.dir
Default Value
/var/log/hive/audit/hdfs/spool
API Name
ranger_hive_plugin_hdfs_audit_spool_directory
Required
true
Description
The directory where Ranger security policies are cached locally.
Related Name
ranger.plugin.hive.policy.cache.dir
Default Value
/var/lib/ranger/hive/policy-cache
API Name
ranger_hive_plugin_policy_cache_directory
Required
true
Description
Spool directory for Ranger audits being written to Solr.
Related Name
xasecure.audit.destination.solr.batch.filespool.dir
Default Value
/var/log/hive/audit/solr/spool
API Name
ranger_hive_plugin_solr_audit_spool_directory
Required
true

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

Description
Port for webapp admin endpoints
Related Name
data_analytics_studio_webapp_admin_port
Default Value
30801
API Name
data_analytics_studio_webapp_admin_port
Required
true
Description
Port to access the DAS UI
Related Name
data_analytics_studio_webapp_server_port
Default Value
30800
API Name
data_analytics_studio_webapp_server_port
Required
true

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
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
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
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
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

Description
The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Data Analytics Studio Webapp 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
das.webapp.ssl.truststore.location
Default Value
API Name
ssl_client_truststore_location
Required
false
Description
The password for the Data Analytics Studio Webapp 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
das.webapp.ssl.truststore.password
Default Value
API Name
ssl_client_truststore_password
Required
false
Description
Encrypt communication between clients and Data Analytics Studio Webapp Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name
data_analytics_studio_webapp_ssl_enabled
Default Value
false
API Name
ssl_enabled
Required
false
Description
The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Data Analytics Studio Webapp Server is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name
data_analytics_studio_webapp_keystore_file
Default Value
API Name
ssl_server_keystore_location
Required
false
Description
The password for the Data Analytics Studio Webapp Server keystore file.
Related Name
das_webapp_keystore_password
Default Value
API Name
ssl_server_keystore_password
Required
false

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
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
Description
Whether or not periodic stacks collection is enabled.
Related Name
stacks_collection_enabled
Default Value
false
API Name
stacks_collection_enabled
Required
true
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
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

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
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/props/webapp.properties parameter.
Related Name
Default Value
false
API Name
role_config_suppression_conf/props/webapp.properties_role_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-hive-audit.xml parameter.
Related Name
Default Value
false
API Name
role_config_suppression_conf/ranger-hive-audit.xml_role_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-hive-policymgr-ssl.xml parameter.
Related Name
Default Value
false
API Name
role_config_suppression_conf/ranger-hive-policymgr-ssl.xml_role_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-hive-security.xml parameter.
Related Name
Default Value
false
API Name
role_config_suppression_conf/ranger-hive-security.xml_role_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Additional Webapp Java Options parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_java_opts
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Basedn parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_basedn
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Custom Query parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_custom_ldap_query
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Domain parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_domain
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Group Class Key parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_group_class_key
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Group DN Pattern parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_group_dn_pattern
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Group Filter parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_group_filter
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Group Membership Key parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_group_membership_key
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP GUID Key parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_guid_key
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP URL parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_url
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP User DN Pattern parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_user_dn_pattern
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP User Filter parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_user_filter
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP User Membership Key parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_user_membership_key
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Webapp Server Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_role_env_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin Users parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_admin_users
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Additional Webapp Classpath parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_additional_classpath
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the DAS Webapp Admin Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_admin_port
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Proxy doAs Param Name parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_doas_param_name
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox JWT Cookie Name parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_knox_cookiename
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox JWT Cookie Public Key parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_knox_publickey
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox SSO Endpoint parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_knox_sso_url
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Logout Endpoint parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_knox_ssout_url
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Redirect Url Param parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_knox_url_query_param
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox SPNEGO User parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_knox_user
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Useragent parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_knox_useragent
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the DAS Webapp Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_server_port
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox SPNEGO Name Rules parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_spnego_name_rules
Required
true
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
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Hive Plugin Audit Hdfs Spool Directory Path parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_hive_plugin_hdfs_audit_spool_directory
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Hive Plugin Policy Cache Directory Path parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_hive_plugin_policy_cache_directory
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Hive Plugin Audit Solr Spool Directory Path parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_hive_plugin_solr_audit_spool_directory
Required
true
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
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
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Webapp Server TLS/SSL Trust Store File parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_location
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Webapp Server TLS/SSL Trust Store Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_password
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Webapp Server TLS/SSL Server Keystore File Location parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_location
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Webapp Server TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_password
Required
true
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
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_das_das_webapp_audit_health
Required
true
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_das_das_webapp_file_descriptor
Required
true
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_das_das_webapp_host_health
Required
true
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_das_das_webapp_log_directory_free_space
Required
true
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_das_das_webapp_scm_health
Required
true
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_das_das_webapp_swap_memory_usage
Required
true
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_das_das_webapp_swap_memory_usage_rate
Required
true
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_das_das_webapp_unexpected_exits
Required
true

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
DAS_service_env_safety_valve
Required
false
Description
The group that this service's processes should run as.
Related Name
Default Value
hive
API Name
process_groupname
Required
true
Description
The user that this service's processes should run as.
Related Name
Default Value
hive
API Name
process_username
Required
true

Description
Name of the host where the database is running.
Related Name
data_analytics_studio_database_host
Default Value
localhost
API Name
data_analytics_studio_database_host
Required
true
Description
DAS database name.
Related Name
data_analytics_studio_database_name
Default Value
das
API Name
data_analytics_studio_database_name
Required
true
Description
DAS database password.
Related Name
data_analytics_studio_database_password
Default Value
API Name
data_analytics_studio_database_password
Required
true
Description
DAS database port.
Related Name
data_analytics_studio_database_port
Default Value
5432
API Name
data_analytics_studio_database_port
Required
true
Description
Database type.
Related Name
data_analytics_studio_database_type
Default Value
postgresql
API Name
data_analytics_studio_database_type
Required
true
Description
DAS database username
Related Name
data_analytics_studio_database_username
Default Value
das
API Name
data_analytics_studio_database_username
Required
true

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
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
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.
For example, the following JSON formatted trigger fires if there are more than 10 DataNodes with more than 500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health: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
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

Description
Hive session parameters which can contain password, stored securely and appended to session parameters.
Related Name
das_hive_secure_session_params
Default Value
API Name
das_hive_secure_session_params
Required
false
Description
Any valid session parameters for Hive: Ex: truststore when using SSL, keystore for two way ssl, protocol, ...
Related Name
das_hive_session_params
Default Value
API Name
das_hive_session_params
Required
false
Description
Name of the HS2 service that this Data Analytics Studio service instance depends on
Related Name
Default Value
API Name
hs2_service
Required
true
Description
Boolean flag indicating whether the Hadoop cluster is secured with Kerberos.
Related Name
kerberos.auth.enabled
Default Value
false
API Name
kerberos.auth.enabled
Required
false
Description
The HDFS path on which Ranger audits are written.
Related Name
xasecure.audit.destination.hdfs.dir
Default Value
$ranger_base_audit_url/hive
API Name
ranger_hive_plugin_hdfs_audit_directory
Required
false
Description
Name of the RANGER service that this Data Analytics Studio service instance depends on
Related Name
Default Value
API Name
ranger_service
Required
false
Description
Name of the TEZ service that this Data Analytics Studio service instance depends on
Related Name
Default Value
API Name
tez_service
Required
true

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
Description
Whether to suppress configuration warnings produced by the Data Analytics Studio Eventprocessor Advanced Configuration Snippet (Safety Valve) for conf/props/eventprocessor.properties configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_conf/props/eventprocessor.properties_role_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the Data Analytics Studio Eventprocessor Advanced Configuration Snippet (Safety Valve) for conf/props/eventprocessor_extra.properties configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_conf/props/eventprocessor_extra.properties_role_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/props/webapp.properties configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_conf/props/webapp.properties_role_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-hive-audit.xml configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_conf/ranger-hive-audit.xml_role_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-hive-policymgr-ssl.xml configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_conf/ranger-hive-policymgr-ssl.xml_role_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-hive-security.xml configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_conf/ranger-hive-security.xml_role_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the Data Analytics Studio Eventprocessor Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_event_processor_role_env_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the Additional Eventprocessor Java Options configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_eventprocessor_java_opts
Required
true
Description
Whether to suppress configuration warnings produced by the Additional Webapp Java Options configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_java_opts
Required
true
Description
Whether to suppress configuration warnings produced by the LDAP Basedn configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_basedn
Required
true
Description
Whether to suppress configuration warnings produced by the LDAP Custom Query configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_custom_ldap_query
Required
true
Description
Whether to suppress configuration warnings produced by the LDAP Domain configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_domain
Required
true
Description
Whether to suppress configuration warnings produced by the LDAP Group Class Key configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_group_class_key
Required
true
Description
Whether to suppress configuration warnings produced by the LDAP Group DN Pattern configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_group_dn_pattern
Required
true
Description
Whether to suppress configuration warnings produced by the LDAP Group Filter configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_group_filter
Required
true
Description
Whether to suppress configuration warnings produced by the LDAP Group Membership Key configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_group_membership_key
Required
true
Description
Whether to suppress configuration warnings produced by the LDAP GUID Key configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_guid_key
Required
true
Description
Whether to suppress configuration warnings produced by the LDAP URL configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_url
Required
true
Description
Whether to suppress configuration warnings produced by the LDAP User DN Pattern configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_user_dn_pattern
Required
true
Description
Whether to suppress configuration warnings produced by the LDAP User Filter configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_user_filter
Required
true
Description
Whether to suppress configuration warnings produced by the LDAP User Membership Key configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_ldap_user_membership_key
Required
true
Description
Whether to suppress configuration warnings produced by the Data Analytics Studio Webapp Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_das_webapp_role_env_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the Admin Users configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_admin_users
Required
true
Description
Whether to suppress configuration warnings produced by the Additional Eventprocessor Classpath configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_ep_additional_classpath
Required
true
Description
Whether to suppress configuration warnings produced by the DAS Eventprocessor Admin Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_event_processor_admin_server_port
Required
true
Description
Whether to suppress configuration warnings produced by the DAS Eventprocessor Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_event_processor_server_port
Required
true
Description
Whether to suppress configuration warnings produced by the Additional Webapp Classpath configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_additional_classpath
Required
true
Description
Whether to suppress configuration warnings produced by the DAS Webapp Admin Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_admin_port
Required
true
Description
Whether to suppress configuration warnings produced by the Knox Proxy doAs Param Name configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_doas_param_name
Required
true
Description
Whether to suppress configuration warnings produced by the Knox JWT Cookie Name configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_knox_cookiename
Required
true
Description
Whether to suppress configuration warnings produced by the Knox JWT Cookie Public Key configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_knox_publickey
Required
true
Description
Whether to suppress configuration warnings produced by the Knox SSO Endpoint configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_knox_sso_url
Required
true
Description
Whether to suppress configuration warnings produced by the Knox Logout Endpoint configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_knox_ssout_url
Required
true
Description
Whether to suppress configuration warnings produced by the Knox Redirect Url Param configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_knox_url_query_param
Required
true
Description
Whether to suppress configuration warnings produced by the Knox SPNEGO User configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_knox_user
Required
true
Description
Whether to suppress configuration warnings produced by the Knox Useragent configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_knox_useragent
Required
true
Description
Whether to suppress configuration warnings produced by the DAS Webapp Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_server_port
Required
true
Description
Whether to suppress configuration warnings produced by the Knox SPNEGO Name Rules configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_data_analytics_studio_webapp_spnego_name_rules
Required
true
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
Description
Whether to suppress configuration warnings produced by the Ranger Hive Plugin Audit Hdfs Spool Directory Path configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_hive_plugin_hdfs_audit_spool_directory
Required
true
Description
Whether to suppress configuration warnings produced by the Ranger Hive Plugin Policy Cache Directory Path configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_hive_plugin_policy_cache_directory
Required
true
Description
Whether to suppress configuration warnings produced by the Ranger Hive Plugin Audit Solr Spool Directory Path configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_hive_plugin_solr_audit_spool_directory
Required
true
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
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
Description
Whether to suppress configuration warnings produced by the Data Analytics Studio Webapp Server TLS/SSL Trust Store File configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_location
Required
true
Description
Whether to suppress configuration warnings produced by the Data Analytics Studio Webapp Server TLS/SSL Trust Store Password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_password
Required
true
Description
Whether to suppress configuration warnings produced by the Data Analytics Studio Webapp Server TLS/SSL Server Keystore File Location configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_location
Required
true
Description
Whether to suppress configuration warnings produced by the Data Analytics Studio Webapp Server TLS/SSL Server Keystore File Password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_password
Required
true
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
Description
Whether to suppress configuration warnings produced by the Data Analytics Studio Eventprocessor Count Validator configuration validator.
Related Name
Default Value
false
API Name
service_config_suppression_das_event_processor_count_validator
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Secure Session Parameters parameter.
Related Name
Default Value
false
API Name
service_config_suppression_das_hive_secure_session_params
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Session Parameters parameter.
Related Name
Default Value
false
API Name
service_config_suppression_das_hive_session_params
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Service Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
service_config_suppression_das_service_env_safety_valve
Required
true
Description
Whether to suppress configuration warnings produced by the Data Analytics Studio Webapp Server Count Validator configuration validator.
Related Name
Default Value
false
API Name
service_config_suppression_das_webapp_count_validator
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the DAS Database Hostname parameter.
Related Name
Default Value
false
API Name
service_config_suppression_data_analytics_studio_database_host
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the DAS Database Name parameter.
Related Name
Default Value
false
API Name
service_config_suppression_data_analytics_studio_database_name
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the DAS Database Password parameter.
Related Name
Default Value
false
API Name
service_config_suppression_data_analytics_studio_database_password
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the DAS Database Port parameter.
Related Name
Default Value
false
API Name
service_config_suppression_data_analytics_studio_database_port
Required
true
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the DAS Database Username parameter.
Related Name
Default Value
false
API Name
service_config_suppression_data_analytics_studio_database_username
Required
true
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
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
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Hive Plugin Hdfs Audit Directory parameter.
Related Name
Default Value
false
API Name
service_config_suppression_ranger_hive_plugin_hdfs_audit_directory
Required
true
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
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