Data Analytics Studio Properties in Cloudera Runtime 7.2.1

Role groups:

Data Analytics Studio Eventprocessor

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Data Analytics Studio Eventprocessor Advanced Configuration Snippet (Safety Valve) for conf/props/eventprocessor.properties For advanced use only. A string to be inserted into conf/props/eventprocessor.properties for this role only. conf/props/eventprocessor.properties_role_safety_valve false
Data Analytics Studio Eventprocessor Advanced Configuration Snippet (Safety Valve) for conf/props/eventprocessor_extra.properties For advanced use only. A string to be inserted into conf/props/eventprocessor_extra.properties for this role only. conf/props/eventprocessor_extra.properties_role_safety_valve false
Data Analytics Studio Eventprocessor Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. DAS_EVENT_PROCESSOR_role_env_safety_valve false
Heap Dump Directory 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, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. 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. oom_heap_dump_dir /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. true oom_heap_dump_enabled true
Kill When Out of Memory When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. true oom_sigkill_enabled true
Automatically Restart Process 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. false process_auto_restart true
Enable Metric Collection 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. true process_should_monitor true
Process Start Retry Attempts 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. 3 process_start_retries false
Process Start Wait Timeout 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. 20 process_start_secs false

Monitoring

Display Name Description Related Name Default Value API Name Required
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % das_event_processor_fd_thresholds false
Data Analytics Studio Eventprocessor Host Health Test When computing the overall Data Analytics Studio Eventprocessor health, consider the host's health. true das_event_processor_host_health_enabled false
Data Analytics Studio Eventprocessor Process Health Test Enables the health test that the Data Analytics Studio Eventprocessor's process state is consistent with the role configuration true das_event_processor_scm_health_enabled false
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Metric Filter 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"] }
monitoring_metric_filter false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. Warning: 200 B, Critical: Never process_swap_memory_thresholds false
Role Triggers The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has 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.
[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

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

Performance

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

Ports and Addresses

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

Resource Management

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

Security

Display Name Description Related Name Default Value API Name Required
Data Analytics Studio Eventprocessor TLS/SSL Client Trust Store File 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 is used when Data Analytics Studio Eventprocessor is the client in a TLS/SSL connection. 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. das.eventprocessor.ssl.truststore.location ssl_client_truststore_location false
Data Analytics Studio Eventprocessor TLS/SSL Client Trust Store Password The password for the Data Analytics Studio Eventprocessor TLS/SSL Certificate 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. das.eventprocessor.ssl.truststore.password ssl_client_truststore_password false
Enable TLS/SSL for Data Analytics Studio Eventprocessor Encrypt communication between clients and Data Analytics Studio Eventprocessor using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). data_analytics_studio_event_processor_ssl_enabled false ssl_enabled false
Data Analytics Studio Eventprocessor TLS/SSL Server JKS Keystore File Location 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 JKS format. data_analytics_studio_event_processor_keystore_file ssl_server_keystore_location false
Data Analytics Studio Eventprocessor TLS/SSL Server JKS Keystore File Password The password for the Data Analytics Studio Eventprocessor JKS keystore file. das_event_processor_keystore_password ssl_server_keystore_password false

Stacks Collection

Display Name Description Related Name Default Value API Name Required
Stacks Collection Data Retention The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. stacks_collection_data_retention 100 MiB stacks_collection_data_retention false
Stacks Collection Directory The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. stacks_collection_directory stacks_collection_directory false
Stacks Collection Enabled Whether or not periodic stacks collection is enabled. stacks_collection_enabled false stacks_collection_enabled true
Stacks Collection Frequency The frequency with which stacks are collected. stacks_collection_frequency 5.0 second(s) stacks_collection_frequency false
Stacks Collection Method 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. stacks_collection_method jstack stacks_collection_method false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Data Analytics Studio Eventprocessor Advanced Configuration Snippet (Safety Valve) for conf/props/eventprocessor.properties 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. false role_config_suppression_conf/props/eventprocessor.properties_role_safety_valve true
Suppress Parameter Validation: Data Analytics Studio Eventprocessor Advanced Configuration Snippet (Safety Valve) for conf/props/eventprocessor_extra.properties 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. false role_config_suppression_conf/props/eventprocessor_extra.properties_role_safety_valve true
Suppress Parameter Validation: Data Analytics Studio Eventprocessor Environment Advanced Configuration Snippet (Safety Valve) 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. false role_config_suppression_das_event_processor_role_env_safety_valve true
Suppress Parameter Validation: Additional Eventprocessor Java Options Whether to suppress configuration warnings produced by the built-in parameter validation for the Additional Eventprocessor Java Options parameter. false role_config_suppression_das_eventprocessor_java_opts true
Suppress Parameter Validation: Additional Eventprocessor Classpath Whether to suppress configuration warnings produced by the built-in parameter validation for the Additional Eventprocessor Classpath parameter. false role_config_suppression_data_analytics_studio_ep_additional_classpath true
Suppress Parameter Validation: DAS Eventprocessor Admin Port Whether to suppress configuration warnings produced by the built-in parameter validation for the DAS Eventprocessor Admin Port parameter. false role_config_suppression_data_analytics_studio_event_processor_admin_server_port true
Suppress Parameter Validation: DAS Eventprocessor Port Whether to suppress configuration warnings produced by the built-in parameter validation for the DAS Eventprocessor Port parameter. false role_config_suppression_data_analytics_studio_event_processor_server_port true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: Data Analytics Studio Eventprocessor TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Eventprocessor TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Data Analytics Studio Eventprocessor TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Eventprocessor TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Data Analytics Studio Eventprocessor TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Eventprocessor TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Data Analytics Studio Eventprocessor TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Eventprocessor TLS/SSL Server JKS Keystore File Password parameter. false role_config_suppression_ssl_server_keystore_password true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Health Test: Audit Pipeline Test 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. false role_health_suppression_das_das_event_processor_audit_health true
Suppress Health Test: File Descriptors 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. false role_health_suppression_das_das_event_processor_file_descriptor true
Suppress Health Test: Host Health 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. false role_health_suppression_das_das_event_processor_host_health true
Suppress Health Test: Log Directory Free Space 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. false role_health_suppression_das_das_event_processor_log_directory_free_space true
Suppress Health Test: Process Status 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. false role_health_suppression_das_das_event_processor_scm_health true
Suppress Health Test: Swap Memory Usage 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. false role_health_suppression_das_das_event_processor_swap_memory_usage true
Suppress Health Test: Unexpected Exits 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. false role_health_suppression_das_das_event_processor_unexpected_exits true

Data Analytics Studio Webapp Server

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/props/webapp.properties For advanced use only. A string to be inserted into conf/props/webapp.properties for this role only. conf/props/webapp.properties_role_safety_valve false
Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-hive-audit.xml For advanced use only. A string to be inserted into conf/ranger-hive-audit.xml for this role only. conf/ranger-hive-audit.xml_role_safety_valve false
Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-hive-policymgr-ssl.xml For advanced use only. A string to be inserted into conf/ranger-hive-policymgr-ssl.xml for this role only. conf/ranger-hive-policymgr-ssl.xml_role_safety_valve false
Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-hive-security.xml For advanced use only. A string to be inserted into conf/ranger-hive-security.xml for this role only. conf/ranger-hive-security.xml_role_safety_valve false
Data Analytics Studio Webapp Server Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. DAS_WEBAPP_role_env_safety_valve false
Heap Dump Directory 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, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. 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. oom_heap_dump_dir /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. true oom_heap_dump_enabled true
Kill When Out of Memory When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. true oom_sigkill_enabled true
Automatically Restart Process 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. false process_auto_restart true
Enable Metric Collection 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. true process_should_monitor true
Process Start Retry Attempts 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. 3 process_start_retries false
Process Start Wait Timeout 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. 20 process_start_secs false

Monitoring

Display Name Description Related Name Default Value API Name Required
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % das_webapp_fd_thresholds false
Data Analytics Studio Webapp Server Host Health Test When computing the overall Data Analytics Studio Webapp Server health, consider the host's health. true das_webapp_host_health_enabled false
Data Analytics Studio Webapp Server Process Health Test Enables the health test that the Data Analytics Studio Webapp Server's process state is consistent with the role configuration true das_webapp_scm_health_enabled false
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Metric Filter 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"] }
monitoring_metric_filter false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. Warning: 200 B, Critical: Never process_swap_memory_thresholds false
Role Triggers The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has 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.
[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value API Name Required
Additional Webapp Java Options These arguments are passed as part of the Java command line. Commonly, garbage collection flags and/or extra debugging flags are set here. das_webapp_java_opts -Xmx4096m das_webapp_java_opts false
LDAP Basedn LDAP basedn das_webapp_ldap_basedn das_webapp_ldap_basedn false
LDAP Custom Query LDAP custom query das_webapp_ldap_custom_ldap_query das_webapp_ldap_custom_ldap_query false
LDAP Domain LDAP domain das_webapp_ldap_domain das_webapp_ldap_domain false
LDAP Group Class Key LDAP group class key das_webapp_ldap_group_class_key das_webapp_ldap_group_class_key false
LDAP Group DN Pattern LDAP group DN pattern das_webapp_ldap_group_dn_pattern das_webapp_ldap_group_dn_pattern false
LDAP Group Filter LDAP group filter das_webapp_ldap_group_filter das_webapp_ldap_group_filter false
LDAP Group Membership Key LDAP group membership key das_webapp_ldap_group_membership_key das_webapp_ldap_group_membership_key false
LDAP GUID Key Knox LDAP GUID key das_webapp_ldap_guid_key das_webapp_ldap_guid_key false
LDAP URL Knox LDAP URL das_webapp_ldap_url das_webapp_ldap_url false
LDAP User DN Pattern LDAP user DN pattern das_webapp_ldap_user_dn_pattern das_webapp_ldap_user_dn_pattern false
LDAP User Filter LDAP user filter das_webapp_ldap_user_filter das_webapp_ldap_user_filter false
LDAP User Membership Key LDAP user membership key das_webapp_ldap_user_membership_key das_webapp_ldap_user_membership_key false
Admin Users List of comma seperator users who should have admin privileges. data_analytics_studio_admin_users data_analytics_studio_admin_users false
DAS User Authentication DAS user authentication, the value DEFAULT maps to NONE in insecure clusters and to SPNEGO in secure clusters. data_analytics_studio_user_authentication DEFAULT data_analytics_studio_user_authentication false
Additional Webapp Classpath Additional Webapp classpath data_analytics_studio_webapp_additional_classpath data_analytics_studio_webapp_additional_classpath false
Knox Proxy doAs Param Name Knox proxy doAs param name data_analytics_studio_webapp_doas_param_name doAs data_analytics_studio_webapp_doas_param_name false
Knox JWT Cookie Name Knox JWT cookie name data_analytics_studio_webapp_knox_cookiename hadoop-jwt data_analytics_studio_webapp_knox_cookiename false
Knox JWT Cookie Public Key Knox JWT Cookie public key data_analytics_studio_webapp_knox_publickey data_analytics_studio_webapp_knox_publickey false
Knox SSO Endpoint Knox SSO endpoint data_analytics_studio_webapp_knox_sso_url data_analytics_studio_webapp_knox_sso_url false
Knox Logout Endpoint Knox logout endpoint data_analytics_studio_webapp_knox_ssout_url data_analytics_studio_webapp_knox_ssout_url false
Knox Redirect Url Param Knox redirect url param data_analytics_studio_webapp_knox_url_query_param originalUrl data_analytics_studio_webapp_knox_url_query_param false
Knox SPNEGO User Knox SPNEGO user data_analytics_studio_webapp_knox_user knox data_analytics_studio_webapp_knox_user false
Knox Useragent Knox useragent data_analytics_studio_webapp_knox_useragent Mozilla, Chrome data_analytics_studio_webapp_knox_useragent false
Webapp Session Timeout The user session timeout in seconds. data_analytics_studio_webapp_session_timeout 1 day(s) data_analytics_studio_webapp_session_timeout false
Knox SPNEGO Name Rules Knox SPNEGO name rules data_analytics_studio_webapp_spnego_name_rules data_analytics_studio_webapp_spnego_name_rules false
Ranger Hive Plugin Audit Hdfs Spool Directory Path Spool directory for Ranger audits being written to DFS. xasecure.audit.destination.hdfs.batch.filespool.dir /var/log/hive/audit/hdfs/spool ranger_hive_plugin_hdfs_audit_spool_directory true
Ranger Hive Plugin Policy Cache Directory Path The directory where Ranger security policies are cached locally. ranger.plugin.hive.policy.cache.dir /var/lib/ranger/hive/policy-cache ranger_hive_plugin_policy_cache_directory true
Ranger Hive Plugin Audit Solr Spool Directory Path Spool directory for Ranger audits being written to Solr. xasecure.audit.destination.solr.batch.filespool.dir /var/log/hive/audit/solr/spool ranger_hive_plugin_solr_audit_spool_directory true

Performance

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

Ports and Addresses

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

Resource Management

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

Security

Display Name Description Related Name Default Value API Name Required
Data Analytics Studio Webapp Server TLS/SSL Client Trust Store File 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 is used when Data Analytics Studio Webapp Server is the client in a TLS/SSL connection. 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. das.webapp.ssl.truststore.location ssl_client_truststore_location false
Data Analytics Studio Webapp Server TLS/SSL Client Trust Store Password The password for the Data Analytics Studio Webapp Server TLS/SSL Certificate 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. das.webapp.ssl.truststore.password ssl_client_truststore_password false
Enable TLS/SSL for Data Analytics Studio Webapp Server Encrypt communication between clients and Data Analytics Studio Webapp Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). data_analytics_studio_webapp_ssl_enabled false ssl_enabled false
Data Analytics Studio Webapp Server TLS/SSL Server JKS Keystore File Location 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 JKS format. data_analytics_studio_webapp_keystore_file ssl_server_keystore_location false
Data Analytics Studio Webapp Server TLS/SSL Server JKS Keystore File Password The password for the Data Analytics Studio Webapp Server JKS keystore file. das_webapp_keystore_password ssl_server_keystore_password false

Stacks Collection

Display Name Description Related Name Default Value API Name Required
Stacks Collection Data Retention The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. stacks_collection_data_retention 100 MiB stacks_collection_data_retention false
Stacks Collection Directory The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. stacks_collection_directory stacks_collection_directory false
Stacks Collection Enabled Whether or not periodic stacks collection is enabled. stacks_collection_enabled false stacks_collection_enabled true
Stacks Collection Frequency The frequency with which stacks are collected. stacks_collection_frequency 5.0 second(s) stacks_collection_frequency false
Stacks Collection Method 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. stacks_collection_method jstack stacks_collection_method false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/props/webapp.properties 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. false role_config_suppression_conf/props/webapp.properties_role_safety_valve true
Suppress Parameter Validation: Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-hive-audit.xml 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. false role_config_suppression_conf/ranger-hive-audit.xml_role_safety_valve true
Suppress Parameter Validation: Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-hive-policymgr-ssl.xml 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. false role_config_suppression_conf/ranger-hive-policymgr-ssl.xml_role_safety_valve true
Suppress Parameter Validation: Data Analytics Studio Webapp Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-hive-security.xml 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. false role_config_suppression_conf/ranger-hive-security.xml_role_safety_valve true
Suppress Parameter Validation: Additional Webapp Java Options Whether to suppress configuration warnings produced by the built-in parameter validation for the Additional Webapp Java Options parameter. false role_config_suppression_das_webapp_java_opts true
Suppress Parameter Validation: LDAP Basedn Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Basedn parameter. false role_config_suppression_das_webapp_ldap_basedn true
Suppress Parameter Validation: LDAP Custom Query Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Custom Query parameter. false role_config_suppression_das_webapp_ldap_custom_ldap_query true
Suppress Parameter Validation: LDAP Domain Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Domain parameter. false role_config_suppression_das_webapp_ldap_domain true
Suppress Parameter Validation: LDAP Group Class Key Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Group Class Key parameter. false role_config_suppression_das_webapp_ldap_group_class_key true
Suppress Parameter Validation: LDAP Group DN Pattern Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Group DN Pattern parameter. false role_config_suppression_das_webapp_ldap_group_dn_pattern true
Suppress Parameter Validation: LDAP Group Filter Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Group Filter parameter. false role_config_suppression_das_webapp_ldap_group_filter true
Suppress Parameter Validation: LDAP Group Membership Key Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Group Membership Key parameter. false role_config_suppression_das_webapp_ldap_group_membership_key true
Suppress Parameter Validation: LDAP GUID Key Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP GUID Key parameter. false role_config_suppression_das_webapp_ldap_guid_key true
Suppress Parameter Validation: LDAP URL Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP URL parameter. false role_config_suppression_das_webapp_ldap_url true
Suppress Parameter Validation: LDAP User DN Pattern Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP User DN Pattern parameter. false role_config_suppression_das_webapp_ldap_user_dn_pattern true
Suppress Parameter Validation: LDAP User Filter Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP User Filter parameter. false role_config_suppression_das_webapp_ldap_user_filter true
Suppress Parameter Validation: LDAP User Membership Key Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP User Membership Key parameter. false role_config_suppression_das_webapp_ldap_user_membership_key true
Suppress Parameter Validation: Data Analytics Studio Webapp Server Environment Advanced Configuration Snippet (Safety Valve) 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. false role_config_suppression_das_webapp_role_env_safety_valve true
Suppress Parameter Validation: Admin Users Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin Users parameter. false role_config_suppression_data_analytics_studio_admin_users true
Suppress Parameter Validation: Additional Webapp Classpath Whether to suppress configuration warnings produced by the built-in parameter validation for the Additional Webapp Classpath parameter. false role_config_suppression_data_analytics_studio_webapp_additional_classpath true
Suppress Parameter Validation: DAS Webapp Admin Port Whether to suppress configuration warnings produced by the built-in parameter validation for the DAS Webapp Admin Port parameter. false role_config_suppression_data_analytics_studio_webapp_admin_port true
Suppress Parameter Validation: Knox Proxy doAs Param Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Proxy doAs Param Name parameter. false role_config_suppression_data_analytics_studio_webapp_doas_param_name true
Suppress Parameter Validation: Knox JWT Cookie Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox JWT Cookie Name parameter. false role_config_suppression_data_analytics_studio_webapp_knox_cookiename true
Suppress Parameter Validation: Knox JWT Cookie Public Key Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox JWT Cookie Public Key parameter. false role_config_suppression_data_analytics_studio_webapp_knox_publickey true
Suppress Parameter Validation: Knox SSO Endpoint Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox SSO Endpoint parameter. false role_config_suppression_data_analytics_studio_webapp_knox_sso_url true
Suppress Parameter Validation: Knox Logout Endpoint Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Logout Endpoint parameter. false role_config_suppression_data_analytics_studio_webapp_knox_ssout_url true
Suppress Parameter Validation: Knox Redirect Url Param Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Redirect Url Param parameter. false role_config_suppression_data_analytics_studio_webapp_knox_url_query_param true
Suppress Parameter Validation: Knox SPNEGO User Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox SPNEGO User parameter. false role_config_suppression_data_analytics_studio_webapp_knox_user true
Suppress Parameter Validation: Knox Useragent Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Useragent parameter. false role_config_suppression_data_analytics_studio_webapp_knox_useragent true
Suppress Parameter Validation: DAS Webapp Port Whether to suppress configuration warnings produced by the built-in parameter validation for the DAS Webapp Port parameter. false role_config_suppression_data_analytics_studio_webapp_server_port true
Suppress Parameter Validation: Knox SPNEGO Name Rules Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox SPNEGO Name Rules parameter. false role_config_suppression_data_analytics_studio_webapp_spnego_name_rules true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Ranger Hive Plugin Audit Hdfs Spool Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Hive Plugin Audit Hdfs Spool Directory Path parameter. false role_config_suppression_ranger_hive_plugin_hdfs_audit_spool_directory true
Suppress Parameter Validation: Ranger Hive Plugin Policy Cache Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Hive Plugin Policy Cache Directory Path parameter. false role_config_suppression_ranger_hive_plugin_policy_cache_directory true
Suppress Parameter Validation: Ranger Hive Plugin Audit Solr Spool Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Hive Plugin Audit Solr Spool Directory Path parameter. false role_config_suppression_ranger_hive_plugin_solr_audit_spool_directory true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: Data Analytics Studio Webapp Server TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Webapp Server TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Data Analytics Studio Webapp Server TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Webapp Server TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Data Analytics Studio Webapp Server TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Webapp Server TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Data Analytics Studio Webapp Server TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Analytics Studio Webapp Server TLS/SSL Server JKS Keystore File Password parameter. false role_config_suppression_ssl_server_keystore_password true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Health Test: Audit Pipeline Test 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. false role_health_suppression_das_das_webapp_audit_health true
Suppress Health Test: File Descriptors 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. false role_health_suppression_das_das_webapp_file_descriptor true
Suppress Health Test: Host Health 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. false role_health_suppression_das_das_webapp_host_health true
Suppress Health Test: Log Directory Free Space 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. false role_health_suppression_das_das_webapp_log_directory_free_space true
Suppress Health Test: Process Status 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. false role_health_suppression_das_das_webapp_scm_health true
Suppress Health Test: Swap Memory Usage 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. false role_health_suppression_das_das_webapp_swap_memory_usage true
Suppress Health Test: Unexpected Exits 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. false role_health_suppression_das_das_webapp_unexpected_exits true

Service-Wide

Categories:

Advanced

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

Database

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

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Service Level Health Alerts When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Service Triggers The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has 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.
[] service_triggers true
Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones. smon_derived_configs_safety_valve false

Other

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

Suppressions

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