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
MATERIALIZED_VIEW_ENGINE_role_env_safety_valve
Required
false
Enable auto refresh for metric configurations🔗
Description
When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value
false
API Name
metric_config_auto_refresh
Required
false
Heap Dump Directory🔗
Description
Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role.
Related Name
oom_heap_dump_dir
Default Value
/tmp
API Name
oom_heap_dump_dir
Required
false
Dump Heap When Out of Memory🔗
Description
When set, generates a heap dump file when when an out-of-memory error occurs.
Related Name
Default Value
true
API Name
oom_heap_dump_enabled
Required
true
Kill When Out of Memory🔗
Description
When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value
true
API Name
oom_sigkill_enabled
Required
true
Automatically Restart Process🔗
Description
When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
Related Name
Default Value
false
API Name
process_auto_restart
Required
true
Enable Metric Collection🔗
Description
Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process.
Related Name
Default Value
true
API Name
process_should_monitor
Required
true
Process Start Retry Attempts🔗
Description
Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period.
Related Name
Default Value
3
API Name
process_start_retries
Required
false
Process Start Wait Timeout🔗
Description
The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature.
Related Name
Default Value
20
API Name
process_start_secs
Required
false
Materialized View Engine Advanced Configuration Snippet (Safety Valve) for ssb-conf/application.properties🔗
Description
For advanced use only. A string to be inserted into ssb-conf/application.properties for this role only.
Related Name
Default Value
API Name
ssb-conf/application.properties_role_safety_valve
Required
false
Logs🔗
Materialized View Engine Log Directory🔗
Description
The log directory for log files of the role Materialized View Engine.
Related Name
log.dir
Default Value
/var/log/ssb
API Name
log_dir
Required
false
Materialized View Engine Logging Threshold🔗
Description
The minimum log level for Materialized View Engine logs
Related Name
Default Value
INFO
API Name
log_threshold
Required
false
Materialized View Engine Maximum Log File Backups🔗
Description
The maximum number of rolled log files to keep for Materialized View Engine logs. Typically used by log4j or logback.
Related Name
Default Value
10
API Name
max_log_backup_index
Required
false
Materialized View Engine Max Log Size🔗
Description
The maximum size, in megabytes, per log file for Materialized View Engine logs. Typically used by log4j or logback.
Related Name
Default Value
200 MiB
API Name
max_log_size
Required
false
Monitoring🔗
Enable Health Alerts for this Role🔗
Description
When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
Related Name
Default Value
true
API Name
enable_alerts
Required
false
Enable Configuration Change Alerts🔗
Description
When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value
false
API Name
enable_config_alerts
Required
false
Log Directory Free Space Monitoring Absolute Thresholds🔗
Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value
Warning: 10 GiB, Critical: 5 GiB
API Name
log_directory_free_space_absolute_thresholds
Required
false
Log Directory Free Space Monitoring Percentage Thresholds🔗
Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
log_directory_free_space_percentage_thresholds
Required
false
File Descriptor Monitoring Thresholds🔗
Description
The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value
Warning: 50.0 %, Critical: 70.0 %
API Name
materialized_view_engine_fd_thresholds
Required
false
Materialized View Engine Host Health Test🔗
Description
When computing the overall Materialized View Engine health, consider the host's health.
Related Name
Default Value
true
API Name
materialized_view_engine_host_health_enabled
Required
false
Materialized View Engine Process Health Test🔗
Description
Enables the health test that the Materialized View Engine's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
materialized_view_engine_scm_health_enabled
Required
false
Metric Filter🔗
Description
Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
Metric Name - The name of a metric that will be included or excluded during metric collection.
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
Swap Memory Usage Rate Thresholds🔗
Description
The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
process_swap_memory_rate_thresholds
Required
false
Swap Memory Usage Rate Window🔗
Description
The period to review when computing unexpected swap memory usage change of the process.
Related Name
common.process.swap_memory_rate_window
Default Value
5 minute(s)
API Name
process_swap_memory_rate_window
Required
false
Process Swap Memory Thresholds🔗
Description
The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value
Warning: 200 B, Critical: Never
API Name
process_swap_memory_thresholds
Required
false
Role Triggers🔗
Description
The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
triggerName(mandatory) - The name of the trigger. This value must be unique for the specific role.
triggerExpression(mandatory) - A tsquery expression representing the trigger.
streamThreshold(optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
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
Unexpected Exits Thresholds🔗
Description
The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value
Warning: Never, Critical: Any
API Name
unexpected_exits_thresholds
Required
false
Unexpected Exits Monitoring Period🔗
Description
The period to review when computing unexpected exits.
Related Name
Default Value
5 minute(s)
API Name
unexpected_exits_window
Required
false
Other🔗
Materialized View Engine JVM Options🔗
Description
Java options to start the JVM of the Materialized View Engine with.
If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value.
Related Name
Default Value
API Name
rlimit_fds
Required
false
Ports and Addresses🔗
Materialized View Engine Port🔗
Description
Materialized View Engine Port.
Related Name
server.port
Default Value
18131
API Name
server.port
Required
true
Resource Management🔗
Cgroup CPU Shares🔗
Description
Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager.
Related Name
cpu.shares
Default Value
1024
API Name
rm_cpu_shares
Required
true
Custom Control Group Resources (overrides Cgroup settings)🔗
Description
Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
Related Name
custom.cgroups
Default Value
API Name
rm_custom_resources
Required
false
Cgroup I/O Weight🔗
Description
Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager.
Related Name
blkio.weight
Default Value
500
API Name
rm_io_weight
Required
true
Cgroup Memory Hard Limit🔗
Description
Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name
memory.limit_in_bytes
Default Value
-1 MiB
API Name
rm_memory_hard_limit
Required
true
Cgroup Memory Soft Limit🔗
Description
Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name
memory.soft_limit_in_bytes
Default Value
-1 MiB
API Name
rm_memory_soft_limit
Required
true
Security🔗
Materialized View Engine TLS/SSL Trust Store File🔗
Description
The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Materialized View Engine 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
server.ssl.trust-store
Default Value
API Name
ssl_client_truststore_location
Required
false
Materialized View Engine TLS/SSL Trust Store Password🔗
Description
The password for the Materialized View Engine 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
server.ssl.trust-store-password
Default Value
API Name
ssl_client_truststore_password
Required
false
Enable TLS/SSL for Materialized View Engine🔗
Description
Encrypt communication between clients and Materialized View Engine using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name
server.ssl.enabled
Default Value
false
API Name
ssl_enabled
Required
false
Materialized View Engine TLS/SSL Server Keystore Key Password🔗
Description
The password that protects the private key contained in the keystore used when Materialized View Engine is acting as a TLS/SSL server.
Related Name
server.ssl.key-password
Default Value
API Name
ssl_server_keystore_keypassword
Required
false
Materialized View Engine TLS/SSL Server Keystore File Location🔗
Description
The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Materialized View Engine is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name
server.ssl.key-store
Default Value
API Name
ssl_server_keystore_location
Required
false
Materialized View Engine TLS/SSL Server Keystore File Password🔗
Description
The password for the Materialized View Engine keystore file.
Related Name
server.ssl.key-store-password
Default Value
API Name
ssl_server_keystore_password
Required
false
Stacks Collection🔗
Stacks Collection Data Retention🔗
Description
The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
Related Name
stacks_collection_data_retention
Default Value
100 MiB
API Name
stacks_collection_data_retention
Required
false
Stacks Collection Directory🔗
Description
The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race.
Related Name
stacks_collection_directory
Default Value
API Name
stacks_collection_directory
Required
false
Stacks Collection Enabled🔗
Description
Whether or not periodic stacks collection is enabled.
Related Name
stacks_collection_enabled
Default Value
false
API Name
stacks_collection_enabled
Required
true
Stacks Collection Frequency🔗
Description
The frequency with which stacks are collected.
Related Name
stacks_collection_frequency
Default Value
5.0 second(s)
API Name
stacks_collection_frequency
Required
false
Stacks Collection Method🔗
Description
The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped.
Related Name
stacks_collection_method
Default Value
jstack
API Name
stacks_collection_method
Required
false
Suppressions🔗
Suppress Configuration Validator: CDH Version Validator🔗
Description
Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Materialized View Engine Environment Advanced Configuration Snippet (Safety Valve) parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_oom_heap_dump_dir
Required
true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_rm_custom_resources
Required
true
Suppress Parameter Validation: Role Triggers🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Materialized View Engine Advanced Configuration Snippet (Safety Valve) for ssb-conf/application.properties parameter.
Suppress Parameter Validation: Materialized View Engine TLS/SSL Trust Store File🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Materialized View Engine TLS/SSL Trust Store File parameter.
Suppress Parameter Validation: Materialized View Engine TLS/SSL Trust Store Password🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Materialized View Engine TLS/SSL Trust Store Password parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Materialized View Engine TLS/SSL Server Keystore Key Password parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Materialized View Engine TLS/SSL Server Keystore File Location parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Materialized View Engine TLS/SSL Server Keystore File Password parameter.
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.
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.
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.
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.
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.
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.
Suppress Health Test: Swap Memory Usage Rate Beta🔗
Description
Whether to suppress the results of the Swap Memory Usage Rate Beta heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
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.
The group that this service's processes should run as.
Related Name
Default Value
ssb
API Name
process_groupname
Required
true
System User🔗
Description
The user that this service's processes should run as.
Related Name
Default Value
ssb
API Name
process_username
Required
true
SQL Stream Builder Service Environment Advanced Configuration Snippet (Safety Valve)🔗
Description
For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name
SQL_STREAM_BUILDER_service_env_safety_valve
Required
false
SQL Stream Builder Service Advanced Configuration Snippet (Safety Valve) for ssb-conf/application.properties🔗
Description
For advanced use only, a string to be inserted into ssb-conf/application.properties. Applies to configurations of all roles in this service except client configuration.
When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
Related Name
Default Value
true
API Name
enable_alerts
Required
false
Enable Configuration Change Alerts🔗
Description
When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value
false
API Name
enable_config_alerts
Required
false
Service Triggers🔗
Description
The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
triggerName(mandatory) - The name of the trigger. This value must be unique for the specific service.
triggerExpression(mandatory) - A tsquery expression representing the trigger.
streamThreshold(optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
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
Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)🔗
Description
For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones.
Related Name
Default Value
API Name
smon_derived_configs_safety_valve
Required
false
Other🔗
User Defined DDL Templates Directory🔗
Description
User Defined DDL Templates Directory.
Related Name
custom_ddl_templates_dir
Default Value
/usr/share/flink-ddl-templates
API Name
custom_ddl_templates_dir
Required
false
DB Connector Jar Directory🔗
Description
Directory that contains the db connector jars (must be present on all hosts!). The connector jars within are expected to be called '(postgresql|mysql|oracle)-connector-java.jar.'
Related Name
db_connector_jar_dir
Default Value
/usr/share/java/
API Name
db_connector_jar_dir
Required
false
Flink Service🔗
Description
Name of the Flink service that this SQL Stream Builder service instance depends on
Related Name
Default Value
API Name
flink_service
Required
true
Flink SQL Connector Jar Directory🔗
Description
Directory that contains extra flink connector jars.
Related Name
flink_sql_connector_jar_dir
Default Value
/usr/share/flink-connectors
API Name
flink_sql_connector_jar_dir
Required
true
Hive Service🔗
Description
Name of the Hive service that this SQL Stream Builder service instance depends on
Related Name
Default Value
API Name
hive_service
Required
false
KAFKA Service🔗
Description
Name of the KAFKA service that this SQL Stream Builder service instance depends on
Related Name
Default Value
API Name
kafka_service
Required
true
KNOX Service🔗
Description
Name of the KNOX service that this SQL Stream Builder service instance depends on
Related Name
Default Value
API Name
knox_service
Required
false
Enable Kerberos Authentication🔗
Description
Enables Kerberos authentication for Streaming SQL
Related Name
security.kerberos.enabled
Default Value
false
API Name
security.kerberos.enabled
Required
false
SPNEGO Keytab🔗
Description
Kerberos keytab file with SPNEGO credentials.
Related Name
security.kerberos.spnego.keytab
Default Value
sql_stream_builder.keytab
API Name
security.kerberos.spnego.keytab
Required
false
SSB Keytab🔗
Description
Kerberos keytab file with SSB credentials.
Related Name
security.kerberos.ssb.keytab
Default Value
sql_stream_builder.keytab
API Name
security.kerberos.ssb.keytab
Required
false
Streaming SQL Proxy Users🔗
Description
Streaming SQL Proxy Users. Users allowed to impersonate other users
Related Name
ssb.proxy.users
Default Value
knox
API Name
ssb.proxy.users
Required
false
StreamBuilder Jar Storage Directory🔗
Description
Directory where the repackaged streambuilder jars will be stored
Related Name
streambuilder_jar_storage_dir
Default Value
/tmp/ssb-jars
API Name
streambuilder_jar_storage_dir
Required
true
Security🔗
Kerberos Principal🔗
Description
Kerberos principal short name used by all roles of this service.
Whether to suppress configuration warnings produced by the Materialized View Engine Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Whether to suppress configuration warnings produced by the Streaming SQL Engine Advanced Configuration Snippet (Safety Valve) for ssb-conf/application.properties configuration validator.
Whether to suppress configuration warnings produced by the Streaming SQL Console Advanced Configuration Snippet (Safety Valve) for ssb-conf/ssb-console-conf.yaml configuration validator.
Whether to suppress configuration warnings produced by the Streaming SQL Console Advanced Configuration Snippet (Safety Valve) for ssb-conf/ssb-console-logging.yaml configuration validator.
Whether to suppress configuration warnings produced by the Streaming SQL Console Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Whether to suppress configuration warnings produced by the Streaming SQL Engine Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the SQL Stream Builder Service Environment Advanced Configuration Snippet (Safety Valve) parameter.
Suppress Parameter Validation: SQL Stream Builder Service Advanced Configuration Snippet (Safety Valve) for ssb-conf/application.properties🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SQL Stream Builder Service Advanced Configuration Snippet (Safety Valve) for ssb-conf/application.properties parameter.
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
Automatically Restart Process🔗
Description
When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
Related Name
Default Value
false
API Name
process_auto_restart
Required
true
Enable Metric Collection🔗
Description
Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process.
Related Name
Default Value
true
API Name
process_should_monitor
Required
true
Process Start Retry Attempts🔗
Description
Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period.
Related Name
Default Value
3
API Name
process_start_retries
Required
false
Process Start Wait Timeout🔗
Description
The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature.
Related Name
Default Value
20
API Name
process_start_secs
Required
false
Streaming SQL Console Advanced Configuration Snippet (Safety Valve) for ssb-conf/ssb-console-conf.yaml🔗
Description
For advanced use only. A string to be inserted into ssb-conf/ssb-console-conf.yaml for this role only.
Related Name
Default Value
API Name
ssb-conf/ssb-console-conf.yaml_role_safety_valve
Required
false
Streaming SQL Console Advanced Configuration Snippet (Safety Valve) for ssb-conf/ssb-console-logging.yaml🔗
Description
For advanced use only. A string to be inserted into ssb-conf/ssb-console-logging.yaml for this role only.
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
STREAMING_SQL_CONSOLE_role_env_safety_valve
Required
false
Logs🔗
Streaming SQL Console Log Directory🔗
Description
The log directory for log files of the role Streaming SQL Console.
Related Name
log_dir
Default Value
/var/log/ssb
API Name
log_dir
Required
false
Monitoring🔗
Enable Health Alerts for this Role🔗
Description
When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
Related Name
Default Value
true
API Name
enable_alerts
Required
false
Enable Configuration Change Alerts🔗
Description
When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value
false
API Name
enable_config_alerts
Required
false
Log Directory Free Space Monitoring Absolute Thresholds🔗
Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value
Warning: 10 GiB, Critical: 5 GiB
API Name
log_directory_free_space_absolute_thresholds
Required
false
Log Directory Free Space Monitoring Percentage Thresholds🔗
Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
log_directory_free_space_percentage_thresholds
Required
false
Metric Filter🔗
Description
Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
Metric Name - The name of a metric that will be included or excluded during metric collection.
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
Swap Memory Usage Rate Thresholds🔗
Description
The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
process_swap_memory_rate_thresholds
Required
false
Swap Memory Usage Rate Window🔗
Description
The period to review when computing unexpected swap memory usage change of the process.
Related Name
common.process.swap_memory_rate_window
Default Value
5 minute(s)
API Name
process_swap_memory_rate_window
Required
false
Process Swap Memory Thresholds🔗
Description
The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value
Warning: 200 B, Critical: Never
API Name
process_swap_memory_thresholds
Required
false
Role Triggers🔗
Description
The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
triggerName(mandatory) - The name of the trigger. This value must be unique for the specific role.
triggerExpression(mandatory) - A tsquery expression representing the trigger.
streamThreshold(optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
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
File Descriptor Monitoring Thresholds🔗
Description
The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value
Warning: 50.0 %, Critical: 70.0 %
API Name
streaming_sql_console_fd_thresholds
Required
false
Streaming SQL Console Host Health Test🔗
Description
When computing the overall Streaming SQL Console health, consider the host's health.
Related Name
Default Value
true
API Name
streaming_sql_console_host_health_enabled
Required
false
Streaming SQL Console Process Health Test🔗
Description
Enables the health test that the Streaming SQL Console's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
streaming_sql_console_scm_health_enabled
Required
false
Unexpected Exits Thresholds🔗
Description
The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value
Warning: Never, Critical: Any
API Name
unexpected_exits_thresholds
Required
false
Unexpected Exits Monitoring Period🔗
Description
The period to review when computing unexpected exits.
Related Name
Default Value
5 minute(s)
API Name
unexpected_exits_window
Required
false
Other🔗
Access level map admin🔗
Description
Access level map admin.
Related Name
access_level_map.admin
Default Value
20
API Name
access_level_map.admin
Required
false
Access level map member🔗
Description
Access level map member.
Related Name
access_level_map.member
Default Value
10
API Name
access_level_map.member
Required
false
Access level map owner🔗
Description
Access level map owner.
Related Name
access_level_map.owner
Default Value
30
API Name
access_level_map.owner
Required
false
Access level map ReadOnly🔗
Description
Access level map ReadOnly.
Related Name
access_level_map.readonly
Default Value
0
API Name
access_level_map.readonly
Required
false
Admin source IPs🔗
Description
Admin source IPs.
Related Name
admin_source_ips
Default Value
API Name
admin_source_ips
Required
false
Streaming SQL Console Default Admin Password🔗
Description
Streaming SQL Console Default Admin Password. Enforced on each Console restart.
Related Name
cloudera_env.admin_password
Default Value
******
API Name
cloudera_env.admin_password
Required
true
Streaming SQL Console Default Admin Username🔗
Description
Streaming SQL Console Default Admin Username. Enforced on each Console restart.
Related Name
cloudera_env.admin_username
Default Value
admin
API Name
cloudera_env.admin_username
Required
true
Default organization ID🔗
Description
Default organization ID.
Related Name
cloudera_env.default_orgid
Default Value
ffffffffffffffffffffffffffffffff
API Name
cloudera_env.default_orgid
Required
false
Enable spnego🔗
Description
Enable spnego.
Related Name
cloudera_env.enable_spnego
Default Value
false
API Name
cloudera_env.enable_spnego
Required
false
Fernet Encryption Key🔗
Description
Base64-encoded 32-byte Fernet key used to encrypt keytabs stored in the admin database. (Changing this key invalidates all currently unlocked keytabs).
Related Name
cloudera_env.keytab_fernet_key
Default Value
******
API Name
cloudera_env.keytab_fernet_key
Required
true
Yarn resource manager external URL override🔗
Description
Provides an option to overwrite the YARN URLs presented to end users. This is typically used direct the end users through the Knox proxy.
Related Name
cloudera_env.yarn_rm_external_url
Default Value
API Name
cloudera_env.yarn_rm_external_url
Required
false
Streaming SQL Console External Lib Path🔗
Description
Streaming SQL Console External Lib Path, used by dependencies we cannot ship for some specific reasons, e.g. DB connectors.
Minimum log level threshold for Steaming SQL console.
Related Name
log_level
Default Value
INFO
API Name
log_level
Required
true
Oracle RDBMS home🔗
Description
Absolute path of the Oracle Database Manager. Used only, when the 'Database Type' is set to 'Oracle'.
Related Name
oracle.home
Default Value
/opt/oracle/product/19c/dbhome_1
API Name
oracle.home
Required
false
Schema Registry Address🔗
Description
Schema Registry rest API address for catalog
Related Name
registry.address
Default Value
API Name
registry.address
Required
false
Rest api key🔗
Description
Rest api key.
Related Name
rest_api_configuration.api_key
Default Value
389736e15bef4fe9b3ba839a640f5eb1
API Name
rest_api_configuration.api_key
Required
false
Materialized View Engine External API URL🔗
Description
Materialized View Engine External API URL.
Related Name
snapper.snapper_external_url
Default Value
API Name
snapper.snapper_external_url
Required
false
Steaming SQL SocketIO Queue ON/OFF Switch🔗
Description
Steaming SQL SocketIO Queue ON/OFF Switch
Related Name
socketio.queue.enabled
Default Value
false
API Name
socketio.queue.enabled
Required
false
Streaming SQL SocketIO Queue Kafka Auto Offset Reset🔗
Description
Kafka auto offset reset
Related Name
socketio.queue.kafka.auto_offset_reset
Default Value
smallest
API Name
socketio.queue.kafka.auto_offset_reset
Required
false
Streaming SQL SocketIO Queue SASL Kerberos Service Name🔗
Description
SASL Kerberos service name
Related Name
socketio.queue.kafka.sasl_kerberos_service_name
Default Value
kafka
API Name
socketio.queue.kafka.sasl_kerberos_service_name
Required
false
Streaming SQL SocketIO Queue Protocol🔗
Description
The protocol type to use for connecting to the queue ( i.e. kafka, redis, etc )
Related Name
socketio.queue.protocol
Default Value
kafka
API Name
socketio.queue.protocol
Required
false
SocketIO Log Level🔗
Description
Minimum log level threshold for SocketIO/EngineIO.
Related Name
socketio_log_level
Default Value
WARNING
API Name
socketio_log_level
Required
true
Superusers🔗
Description
Superusers.
Related Name
superusers
Default Value
eventador_support
API Name
superusers
Required
false
Performance🔗
Maximum Process File Descriptors🔗
Description
If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value.
Related Name
Default Value
API Name
rlimit_fds
Required
false
Ports and Addresses🔗
Steaming SQL Console Port🔗
Description
Steaming SQL Console Port.
Related Name
console.port
Default Value
18111
API Name
console.port
Required
true
Steaming SQL Console Secure Port🔗
Description
Steaming SQL Console Secure Port.
Related Name
console.secure.port
Default Value
18112
API Name
console.secure.port
Required
true
Resource Management🔗
Cgroup CPU Shares🔗
Description
Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager.
Related Name
cpu.shares
Default Value
1024
API Name
rm_cpu_shares
Required
true
Custom Control Group Resources (overrides Cgroup settings)🔗
Description
Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
Related Name
custom.cgroups
Default Value
API Name
rm_custom_resources
Required
false
Cgroup I/O Weight🔗
Description
Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager.
Related Name
blkio.weight
Default Value
500
API Name
rm_io_weight
Required
true
Cgroup Memory Hard Limit🔗
Description
Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name
memory.limit_in_bytes
Default Value
-1 MiB
API Name
rm_memory_hard_limit
Required
true
Cgroup Memory Soft Limit🔗
Description
Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name
memory.soft_limit_in_bytes
Default Value
-1 MiB
API Name
rm_memory_soft_limit
Required
true
Security🔗
Streaming SQL Console TLS/SSL Certificate Trust Store File🔗
Description
The location on disk of the trust store, in .pem format, used to confirm the authenticity of TLS/SSL servers that Streaming SQL Console might connect to. This is used when Streaming SQL Console 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.
Related Name
ssl_client_truststore_location
Default Value
API Name
ssl_client_truststore_location
Required
false
Enable TLS/SSL for Streaming SQL Console🔗
Description
Encrypt communication between clients and Streaming SQL Console using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name
ssl_enabled
Default Value
false
API Name
ssl_enabled
Required
false
Streaming SQL Console TLS/SSL Server CA Certificate (PEM Format)🔗
Description
The path to the TLS/SSL file containing the certificate of the certificate authority (CA) and any intermediate certificates used to sign the server certificate. Used when Streaming SQL Console is acting as a TLS/SSL server. The certificate file must be in PEM format, and is usually created by concatenating all of the appropriate root and intermediate certificates.
Related Name
ssl_server_ca_certificate_location
Default Value
API Name
ssl_server_ca_certificate_location
Required
false
Streaming SQL Console TLS/SSL Server Certificate File (PEM Format)🔗
Description
The path to the TLS/SSL file containing the server certificate key used for TLS/SSL. Used when Streaming SQL Console is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name
ssl_server_certificate_location
Default Value
API Name
ssl_server_certificate_location
Required
false
Streaming SQL Console TLS/SSL Server Private Key File (PEM Format)🔗
Description
The path to the TLS/SSL file containing the private key used for TLS/SSL. Used when Streaming SQL Console is acting as a TLS/SSL server. The certificate file must be in PEM format.
The password for the private key in the Streaming SQL Console TLS/SSL Server Certificate and Private Key file. If left blank, the private key is not protected by a password.
Related Name
ssl_server_privatekey_password
Default Value
API Name
ssl_server_privatekey_password
Required
false
Suppressions🔗
Suppress Parameter Validation: Admin source IPs🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin source IPs parameter.
Related Name
Default Value
false
API Name
role_config_suppression_admin_source_ips
Required
true
Suppress Configuration Validator: CDH Version Validator🔗
Description
Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Console Default Admin Password parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Console Default Admin Username parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Yarn resource manager external URL override parameter.
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_rm_custom_resources
Required
true
Suppress Parameter Validation: Role Triggers🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value
false
API Name
role_config_suppression_role_triggers
Required
true
Suppress Parameter Validation: Materialized View Engine External API URL🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Materialized View Engine External API URL parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL SocketIO Queue Kafka Auto Offset Reset parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL SocketIO Queue SASL Kerberos Service Name parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Console Advanced Configuration Snippet (Safety Valve) for ssb-conf/ssb-console-conf.yaml parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Console Advanced Configuration Snippet (Safety Valve) for ssb-conf/ssb-console-logging.yaml parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Console TLS/SSL Certificate Trust Store File parameter.
Suppress Parameter Validation: Streaming SQL Console TLS/SSL Server CA Certificate (PEM Format)🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Console TLS/SSL Server CA Certificate (PEM Format) parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Console TLS/SSL Server Certificate File (PEM Format) parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Console TLS/SSL Server Private Key File (PEM Format) parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Console TLS/SSL Private Key Password parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Console Environment Advanced Configuration Snippet (Safety Valve) parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Superusers parameter.
Related Name
Default Value
false
API Name
role_config_suppression_superusers
Required
true
Suppress Health Test: Audit Pipeline Test🔗
Description
Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
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.
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.
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.
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.
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.
Suppress Health Test: Swap Memory Usage Rate Beta🔗
Description
Whether to suppress the results of the Swap Memory Usage Rate Beta heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
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.
For advanced use only, replace entire XML in the logback configuration file for Streaming SQL Engine, ignoring all logging configuration.
Related Name
logback_safety_valve
Default Value
API Name
logback_safety_valve
Required
false
Enable auto refresh for metric configurations🔗
Description
When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value
false
API Name
metric_config_auto_refresh
Required
false
Heap Dump Directory🔗
Description
Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role.
Related Name
oom_heap_dump_dir
Default Value
/tmp
API Name
oom_heap_dump_dir
Required
false
Dump Heap When Out of Memory🔗
Description
When set, generates a heap dump file when when an out-of-memory error occurs.
Related Name
Default Value
true
API Name
oom_heap_dump_enabled
Required
true
Kill When Out of Memory🔗
Description
When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value
true
API Name
oom_sigkill_enabled
Required
true
Automatically Restart Process🔗
Description
When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
Related Name
Default Value
false
API Name
process_auto_restart
Required
true
Enable Metric Collection🔗
Description
Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process.
Related Name
Default Value
true
API Name
process_should_monitor
Required
true
Process Start Retry Attempts🔗
Description
Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period.
Related Name
Default Value
3
API Name
process_start_retries
Required
false
Process Start Wait Timeout🔗
Description
The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature.
Related Name
Default Value
20
API Name
process_start_secs
Required
false
Streaming SQL Engine Advanced Configuration Snippet (Safety Valve) for ssb-conf/application.properties🔗
Description
For advanced use only. A string to be inserted into ssb-conf/application.properties for this role only.
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
STREAMING_SQL_ENGINE_role_env_safety_valve
Required
false
Logs🔗
Streaming SQL Engine Log Directory🔗
Description
The log directory for log files of the role Streaming SQL Engine.
Related Name
log.dir
Default Value
/var/log/ssb
API Name
log_dir
Required
false
Streaming SQL Engine Logging Threshold🔗
Description
The minimum log level for Streaming SQL Engine logs
Related Name
Default Value
INFO
API Name
log_threshold
Required
false
Streaming SQL Engine Maximum Log File Backups🔗
Description
The maximum number of rolled log files to keep for Streaming SQL Engine logs. Typically used by log4j or logback.
Related Name
Default Value
10
API Name
max_log_backup_index
Required
false
Streaming SQL Engine Max Log Size🔗
Description
The maximum size, in megabytes, per log file for Streaming SQL Engine logs. Typically used by log4j or logback.
Related Name
Default Value
200 MiB
API Name
max_log_size
Required
false
Monitoring🔗
Enable Health Alerts for this Role🔗
Description
When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
Related Name
Default Value
true
API Name
enable_alerts
Required
false
Enable Configuration Change Alerts🔗
Description
When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value
false
API Name
enable_config_alerts
Required
false
Log Directory Free Space Monitoring Absolute Thresholds🔗
Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value
Warning: 10 GiB, Critical: 5 GiB
API Name
log_directory_free_space_absolute_thresholds
Required
false
Log Directory Free Space Monitoring Percentage Thresholds🔗
Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
log_directory_free_space_percentage_thresholds
Required
false
Metric Filter🔗
Description
Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
Metric Name - The name of a metric that will be included or excluded during metric collection.
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
Swap Memory Usage Rate Thresholds🔗
Description
The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
process_swap_memory_rate_thresholds
Required
false
Swap Memory Usage Rate Window🔗
Description
The period to review when computing unexpected swap memory usage change of the process.
Related Name
common.process.swap_memory_rate_window
Default Value
5 minute(s)
API Name
process_swap_memory_rate_window
Required
false
Process Swap Memory Thresholds🔗
Description
The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value
Warning: 200 B, Critical: Never
API Name
process_swap_memory_thresholds
Required
false
Role Triggers🔗
Description
The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
triggerName(mandatory) - The name of the trigger. This value must be unique for the specific role.
triggerExpression(mandatory) - A tsquery expression representing the trigger.
streamThreshold(optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
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
File Descriptor Monitoring Thresholds🔗
Description
The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value
Warning: 50.0 %, Critical: 70.0 %
API Name
streaming_sql_engine_fd_thresholds
Required
false
Streaming SQL Engine Host Health Test🔗
Description
When computing the overall Streaming SQL Engine health, consider the host's health.
Related Name
Default Value
true
API Name
streaming_sql_engine_host_health_enabled
Required
false
Streaming SQL Engine Process Health Test🔗
Description
Enables the health test that the Streaming SQL Engine's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
streaming_sql_engine_scm_health_enabled
Required
false
Unexpected Exits Thresholds🔗
Description
The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value
Warning: Never, Critical: Any
API Name
unexpected_exits_thresholds
Required
false
Unexpected Exits Monitoring Period🔗
Description
The period to review when computing unexpected exits.
Related Name
Default Value
5 minute(s)
API Name
unexpected_exits_window
Required
false
Other🔗
Streaming SQL Engine JVM Options🔗
Description
Java options to start the JVM of the Streaming SQL Engine with.
Related Name
env_java_opts_streaming_sql_engine
Default Value
API Name
env_java_opts_streaming_sql_engine
Required
false
Kafka Reaper Period (minutes)🔗
Description
Minutes between Kafka Reaper runs to delete unused internal topics
Related Name
spring.kafka.reaper.period
Default Value
60
API Name
spring.kafka.reaper.period
Required
true
Performance🔗
Maximum Process File Descriptors🔗
Description
If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value.
Related Name
Default Value
API Name
rlimit_fds
Required
false
Ports and Addresses🔗
Streaming SQL Engine Port🔗
Description
Streaming SQL Engine Port.
Related Name
server.port
Default Value
18121
API Name
server.port
Required
true
Resource Management🔗
Cgroup CPU Shares🔗
Description
Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager.
Related Name
cpu.shares
Default Value
1024
API Name
rm_cpu_shares
Required
true
Custom Control Group Resources (overrides Cgroup settings)🔗
Description
Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
Related Name
custom.cgroups
Default Value
API Name
rm_custom_resources
Required
false
Cgroup I/O Weight🔗
Description
Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager.
Related Name
blkio.weight
Default Value
500
API Name
rm_io_weight
Required
true
Cgroup Memory Hard Limit🔗
Description
Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name
memory.limit_in_bytes
Default Value
-1 MiB
API Name
rm_memory_hard_limit
Required
true
Cgroup Memory Soft Limit🔗
Description
Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name
memory.soft_limit_in_bytes
Default Value
-1 MiB
API Name
rm_memory_soft_limit
Required
true
Security🔗
Streaming SQL Engine TLS/SSL Trust Store File🔗
Description
The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Streaming SQL Engine 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
server.ssl.trust-store
Default Value
API Name
ssl_client_truststore_location
Required
false
Streaming SQL Engine TLS/SSL Trust Store Password🔗
Description
The password for the Streaming SQL Engine 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
server.ssl.trust-store-password
Default Value
API Name
ssl_client_truststore_password
Required
false
Enable TLS/SSL for Streaming SQL Engine🔗
Description
Encrypt communication between clients and Streaming SQL Engine using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name
server.ssl.enabled
Default Value
false
API Name
ssl_enabled
Required
false
Streaming SQL Engine TLS/SSL Server Keystore Key Password🔗
Description
The password that protects the private key contained in the keystore used when Streaming SQL Engine is acting as a TLS/SSL server.
Related Name
server.ssl.key-password
Default Value
API Name
ssl_server_keystore_keypassword
Required
false
Streaming SQL Engine TLS/SSL Server Keystore File Location🔗
Description
The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Streaming SQL Engine is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name
server.ssl.key-store
Default Value
API Name
ssl_server_keystore_location
Required
false
Streaming SQL Engine TLS/SSL Server Keystore File Password🔗
Description
The password for the Streaming SQL Engine keystore file.
Related Name
server.ssl.key-store-password
Default Value
API Name
ssl_server_keystore_password
Required
false
Stacks Collection🔗
Stacks Collection Data Retention🔗
Description
The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
Related Name
stacks_collection_data_retention
Default Value
100 MiB
API Name
stacks_collection_data_retention
Required
false
Stacks Collection Directory🔗
Description
The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race.
Related Name
stacks_collection_directory
Default Value
API Name
stacks_collection_directory
Required
false
Stacks Collection Enabled🔗
Description
Whether or not periodic stacks collection is enabled.
Related Name
stacks_collection_enabled
Default Value
false
API Name
stacks_collection_enabled
Required
true
Stacks Collection Frequency🔗
Description
The frequency with which stacks are collected.
Related Name
stacks_collection_frequency
Default Value
5.0 second(s)
API Name
stacks_collection_frequency
Required
false
Stacks Collection Method🔗
Description
The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped.
Related Name
stacks_collection_method
Default Value
jstack
API Name
stacks_collection_method
Required
false
Suppressions🔗
Suppress Configuration Validator: CDH Version Validator🔗
Description
Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_oom_heap_dump_dir
Required
true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_rm_custom_resources
Required
true
Suppress Parameter Validation: Role Triggers🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Engine Advanced Configuration Snippet (Safety Valve) for ssb-conf/application.properties parameter.
Suppress Parameter Validation: Streaming SQL Engine TLS/SSL Trust Store File🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Engine TLS/SSL Trust Store File parameter.
Suppress Parameter Validation: Streaming SQL Engine TLS/SSL Trust Store Password🔗
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Engine TLS/SSL Trust Store Password parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Engine TLS/SSL Server Keystore Key Password parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Engine TLS/SSL Server Keystore File Location parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Engine TLS/SSL Server Keystore File Password parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streaming SQL Engine Environment Advanced Configuration Snippet (Safety Valve) parameter.
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.
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.
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.
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.
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.
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.
Suppress Health Test: Swap Memory Usage Rate Beta🔗
Description
Whether to suppress the results of the Swap Memory Usage Rate Beta heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
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.
