Streams Replication Manager Properties in Cloudera Runtime 7.1.8

Role groups:

Service-Wide

Advanced

System Group

Description
The group that this service's processes should run as.
Related Name
Default Value
streamsrepmgr
API Name
process_groupname
Required
true

System User

Description
The user that this service's processes should run as.
Related Name
Default Value
streamsrepmgr
API Name
process_username
Required
true

Streams Replication Manager Service Advanced Configuration Snippet (Safety Valve) for srm.properties

Description
For advanced use only, a string to be inserted into srm.properties. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name
srm.properties_service_safety_valve
Required
false

Streams Replication Manager 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
STREAMS_REPLICATION_MANAGER_service_env_safety_valve
Required
false

Monitoring

Enable Service Level Health Alerts

Description
When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
Related Name
Default Value
true
API Name
enable_alerts
Required
false

Enable Configuration Change Alerts

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

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

Healthy SRM Driver Monitoring Thresholds

Description
The health test thresholds of the overall SRM Driver health. The check returns "Concerning" health if the percentage of "Healthy" SRM Drivers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" SRM Drivers falls below the critical threshold.
Related Name
Default Value
Warning: 94.99 %, Critical: 49.99 %
API Name
STREAMS_REPLICATION_MANAGER_STREAMS_REPLICATION_MANAGER_DRIVER_healthy_thresholds
Required
false

Healthy SRM Service Monitoring Thresholds

Description
The health test thresholds of the overall SRM Service health. The check returns "Concerning" health if the percentage of "Healthy" SRM Services falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" SRM Services falls below the critical threshold.
Related Name
Default Value
Warning: 94.99 %, Critical: 49.99 %
API Name
STREAMS_REPLICATION_MANAGER_STREAMS_REPLICATION_MANAGER_SERVICE_healthy_thresholds
Required
false

Other

Streams Replication Manager Cluster alias

Description
Specifies cluster aliases for the clusters SRM is connecting to. Cluster aliases are comma delimited. For example, 'primary, backup'.
Related Name
clusters
Default Value
API Name
clusters
Required
true

Emit Checkpoints Interval Seconds

Description
The interval at which SRM emits checkpoint information.
Related Name
emit.checkpoints.interval.seconds
Default Value
5 second(s)
API Name
emit.checkpoints.interval.seconds
Required
true

Kafka Service

Description
Name of the Kafka service that this Streams Replication Manager service instance depends on
Related Name
Default Value
API Name
kafka_service
Required
false

Enable Kerberos Authentication

Description
Enables Kerberos authentication for this Streams Replication Manager.
Related Name
kerberos.auth.enable
Default Value
false
API Name
kerberos.auth.enable
Required
false

Replication Factor for Metrics Topics

Description
Replication factor for all metrics topics.
Related Name
metrics.topic.replication.factor
Default Value
3
API Name
metrics.topic.replication.factor
Required
false

Refresh Groups Interval Seconds

Description
The interval at which SRM looks for new consumer groups on source clusters.
Related Name
refresh.groups.interval.seconds
Default Value
10 minute(s)
API Name
refresh.groups.interval.seconds
Required
true

Refresh Topics Interval Seconds

Description
The interval at which SRM looks for new topics on source clusters.
Related Name
refresh.topics.interval.seconds
Default Value
10 minute(s)
API Name
refresh.topics.interval.seconds
Required
true

SRM_HEAP_OPTS

Description
Memory heap params.
Related Name
SRM_HEAP_OPTS
Default Value
-Xmx8G -Xms1G
API Name
SRM_HEAP_OPTS
Required
false

SRM_JMX_OPTS

Description
Change parameters to setup jmxremote.
Related Name
SRM_JMX_OPTS
Default Value
-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false
API Name
SRM_JMX_OPTS
Required
false

SRM_JVM_PERF_OPTS

Description
SRM JVM perf and gc opts.
Related Name
SRM_JVM_PERF_OPTS
Default Value
-server -XX:+UseG1GC -XX:MaxGCPauseMillis=20 -XX:InitiatingHeapOccupancyPercent=35 -XX:+ExplicitGCInvokesConcurrent -Djava.awt.headless=true
API Name
SRM_JVM_PERF_OPTS
Required
false

Streams Replication Manager's Replication Configs

Description
Specifies cluster bootstrap server information and cluster replication pairs. Bootstrap information for each alias defined in the clusters property has to be added as follows: 'primary.bootstrap.servers=mycluster1.example.com:9092,primary.bootstrap.servers=mycluster2.example.com:9092'.. Each cluster has to be added in a new line, if cluster has multiple nodes, add all nodes to the same line and delimit each with a comma. Cluster replication pairs can be defined as follows: 'primary->backup.enabled=true'.. Each unique replication pair has to be added in a new line.
Related Name
streams.replication.manager.config
Default Value
API Name
streams.replication.manager.config
Required
true

Sync Topic Acls Enabled

Description
Enables the monitoring of the source cluster for ACL changes.
Related Name
sync.topic.acls.enabled
Default Value
false
API Name
sync.topic.acls.enabled
Required
true

Sync Topic Acls Interval Seconds

Description
The interval at which SRM checks the source cluster for ACL changes.
Related Name
sync.topic.acls.interval.seconds
Default Value
30 second(s)
API Name
sync.topic.acls.interval.seconds
Required
true

Sync Topic Configs Interval Seconds

Description
The interval at which SRM checks the source cluster for configuration changes.
Related Name
sync.topic.configs.interval.seconds
Default Value
10 minute(s)
API Name
sync.topic.configs.interval.seconds
Required
true

Tasks Max

Description
Maximum number of tasks for replication between clusters.
Related Name
tasks.max
Default Value
3
API Name
tasks.max
Required
true

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description
Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_cdh_version_validator
Required
true

Suppress Configuration Validator: SRM Driver Log Directory

Description
Whether to suppress configuration warnings produced by the SRM Driver Log Directory configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_log_dir
Required
true

Suppress Configuration Validator: SRM Driver XML Override

Description
Whether to suppress configuration warnings produced by the SRM Driver XML Override configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_logback_safety_valve
Required
true

Suppress Configuration Validator: Heap Dump Directory

Description
Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_oom_heap_dump_dir
Required
true

Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings)

Description
Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_rm_custom_resources
Required
true

Suppress Configuration Validator: Role Triggers

Description
Whether to suppress configuration warnings produced by the Role Triggers configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_role_triggers
Required
true

Suppress Configuration Validator: SRM Service Advanced Configuration Snippet (Safety Valve) for srm-service.yaml

Description
Whether to suppress configuration warnings produced by the SRM Service Advanced Configuration Snippet (Safety Valve) for srm-service.yaml configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_srm-service.yaml_role_safety_valve
Required
true

Suppress Configuration Validator: SRM Driver Advanced Configuration Snippet (Safety Valve) for srm.properties

Description
Whether to suppress configuration warnings produced by the SRM Driver Advanced Configuration Snippet (Safety Valve) for srm.properties configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_srm.properties_role_safety_valve
Required
true

Suppress Configuration Validator: SRM Driver TLS/SSL Trust Store File

Description
Whether to suppress configuration warnings produced by the SRM Driver TLS/SSL Trust Store File configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_location
Required
true

Suppress Configuration Validator: SRM Driver TLS/SSL Trust Store Password

Description
Whether to suppress configuration warnings produced by the SRM Driver TLS/SSL Trust Store Password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_password
Required
true

Suppress Configuration Validator: SRM Driver TLS/SSL Server Keystore Key Password

Description
Whether to suppress configuration warnings produced by the SRM Driver TLS/SSL Server Keystore Key Password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_keypassword
Required
true

Suppress Configuration Validator: SRM Driver TLS/SSL Server Keystore File Location

Description
Whether to suppress configuration warnings produced by the SRM Driver TLS/SSL Server Keystore File Location configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_location
Required
true

Suppress Configuration Validator: SRM Driver TLS/SSL Server Keystore File Password

Description
Whether to suppress configuration warnings produced by the SRM Driver TLS/SSL Server Keystore File Password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_password
Required
true

Suppress Configuration Validator: Stacks Collection Directory

Description
Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_stacks_collection_directory
Required
true

Suppress Configuration Validator: Streams Replication Manager Driver Target Cluster

Description
Whether to suppress configuration warnings produced by the Streams Replication Manager Driver Target Cluster configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.driver.target.cluster
Required
true

Suppress Configuration Validator: Java Home Path Override

Description
Whether to suppress configuration warnings produced by the Java Home Path Override configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.jdk.home
Required
true

Suppress Configuration Validator: Log Format

Description
Whether to suppress configuration warnings produced by the Log Format configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.log.format
Required
true

Suppress Configuration Validator: SRM Service Port

Description
Whether to suppress configuration warnings produced by the SRM Service Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.service.port
Required
true

Suppress Configuration Validator: SRM Service Rpc Port

Description
Whether to suppress configuration warnings produced by the SRM Service Rpc Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.service.rpcport
Required
true

Suppress Configuration Validator: SRM Service Https Port

Description
Whether to suppress configuration warnings produced by the SRM Service Https Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.service.ssl.port
Required
true

Suppress Configuration Validator: Streams Replication Manager Service Target Cluster

Description
Whether to suppress configuration warnings produced by the Streams Replication Manager Service Target Cluster configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.service.target.cluster
Required
true

Suppress Configuration Validator: SSL Keystore Type

Description
Whether to suppress configuration warnings produced by the SSL Keystore Type configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.ssl.keystoretype
Required
true

Suppress Configuration Validator: SSL TrustStore Type

Description
Whether to suppress configuration warnings produced by the SSL TrustStore Type configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.ssl.truststoretype
Required
true

Suppress Configuration Validator: SSL ValidateCerts

Description
Whether to suppress configuration warnings produced by the SSL ValidateCerts configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.ssl.validatecerts
Required
true

Suppress Configuration Validator: SSL ValidatePeers

Description
Whether to suppress configuration warnings produced by the SSL ValidatePeers configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.ssl.validatepeers
Required
true

Suppress Configuration Validator: SRM Driver Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the SRM Driver Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams_replication_manager_driver_role_env_safety_valve
Required
true

Suppress Configuration Validator: SRM Service Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the SRM Service Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams_replication_manager_service_role_env_safety_valve
Required
true

Suppress Parameter Validation: Streams Replication Manager Cluster alias

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Replication Manager Cluster alias parameter.
Related Name
Default Value
false
API Name
service_config_suppression_clusters
Required
true

Suppress Parameter Validation: Replication Factor for Metrics Topics

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Replication Factor for Metrics Topics parameter.
Related Name
Default Value
false
API Name
service_config_suppression_metrics.topic.replication.factor
Required
true

Suppress Parameter Validation: System Group

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter.
Related Name
Default Value
false
API Name
service_config_suppression_process_groupname
Required
true

Suppress Parameter Validation: System User

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter.
Related Name
Default Value
false
API Name
service_config_suppression_process_username
Required
true

Suppress Parameter Validation: Service Triggers

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter.
Related Name
Default Value
false
API Name
service_config_suppression_service_triggers
Required
true

Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
service_config_suppression_smon_derived_configs_safety_valve
Required
true

Suppress Parameter Validation: Streams Replication Manager Service Advanced Configuration Snippet (Safety Valve) for srm.properties

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Replication Manager Service Advanced Configuration Snippet (Safety Valve) for srm.properties parameter.
Related Name
Default Value
false
API Name
service_config_suppression_srm.properties_service_safety_valve
Required
true

Suppress Parameter Validation: SRM_HEAP_OPTS

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM_HEAP_OPTS parameter.
Related Name
Default Value
false
API Name
service_config_suppression_srm_heap_opts
Required
true

Suppress Parameter Validation: SRM_JMX_OPTS

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM_JMX_OPTS parameter.
Related Name
Default Value
false
API Name
service_config_suppression_srm_jmx_opts
Required
true

Suppress Parameter Validation: SRM_JVM_PERF_OPTS

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM_JVM_PERF_OPTS parameter.
Related Name
Default Value
false
API Name
service_config_suppression_srm_jvm_perf_opts
Required
true

Suppress Parameter Validation: Streams Replication Manager's Replication Configs

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Replication Manager's Replication Configs parameter.
Related Name
Default Value
false
API Name
service_config_suppression_streams.replication.manager.config
Required
true

Suppress Configuration Validator: SRM Driver Count Validator

Description
Whether to suppress configuration warnings produced by the SRM Driver Count Validator configuration validator.
Related Name
Default Value
false
API Name
service_config_suppression_streams_replication_manager_driver_count_validator
Required
true

Suppress Configuration Validator: SRM Service Count Validator

Description
Whether to suppress configuration warnings produced by the SRM Service Count Validator configuration validator.
Related Name
Default Value
false
API Name
service_config_suppression_streams_replication_manager_service_count_validator
Required
true

Suppress Parameter Validation: Streams Replication Manager Service Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Replication Manager Service Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
service_config_suppression_streams_replication_manager_service_env_safety_valve
Required
true

Suppress Health Test: SRM Driver Health

Description
Whether to suppress the results of the SRM Driver Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
service_health_suppression_streams_replication_manager_streams_replication_manager_driver_healthy
Required
true

Suppress Health Test: SRM Service Health

Description
Whether to suppress the results of the SRM Service Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
service_health_suppression_streams_replication_manager_streams_replication_manager_service_healthy
Required
true

SRM Driver

Advanced

SRM Driver XML Override

Description
For advanced use only, replace entire XML in the logback configuration file for SRM Driver, 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

SRM Driver Advanced Configuration Snippet (Safety Valve) for srm.properties

Description
For advanced use only. A string to be inserted into srm.properties for this role only.
Related Name
Default Value
API Name
srm.properties_role_safety_valve
Required
false

SRM Driver Environment Advanced Configuration Snippet (Safety Valve)

Description
For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration.
Related Name
Default Value
API Name
STREAMS_REPLICATION_MANAGER_DRIVER_role_env_safety_valve
Required
false

Logs

SRM Driver Log Directory

Description
The log directory for log files of the role SRM Driver.
Related Name
log_dir
Default Value
/var/log/streams-replication-manager
API Name
log_dir
Required
false

SRM Driver Logging Threshold

Description
The minimum log level for SRM Driver logs
Related Name
Default Value
INFO
API Name
log_threshold
Required
false

SRM Driver Maximum Log File Backups

Description
The maximum number of rolled log files to keep for SRM Driver logs. Typically used by log4j or logback.
Related Name
Default Value
10
API Name
max_log_backup_index
Required
false

SRM Driver Max Log Size

Description
The maximum size, in megabytes, per log file for SRM Driver 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
streams_replication_manager_driver_fd_thresholds
Required
false

SRM Driver Host Health Test

Description
When computing the overall SRM Driver health, consider the host's health.
Related Name
Default Value
true
API Name
streams_replication_manager_driver_host_health_enabled
Required
false

SRM Driver Process Health Test

Description
Enables the health test that the SRM Driver's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
streams_replication_manager_driver_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

Streams Replication Manager Driver Target Cluster

Description
Target cluster aliases for the srm-driver. When set, the srm-driver will collect data from all clusters, but will only write to the clusters specified here. Cluster aliases are comma separated.
Related Name
streams.replication.manager.driver.target.cluster
Default Value
API Name
streams.replication.manager.driver.target.cluster
Required
false

Java Home Path Override

Description
Java Home Path Override for Streams Replication Manager. If left empty, the java shipped with CM is used.
Related Name
streams.replication.manager.jdk.home
Default Value
API Name
streams.replication.manager.jdk.home
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

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

SRM Driver 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 SRM Driver 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
ssl.truststore.location
Default Value
API Name
ssl_client_truststore_location
Required
false

SRM Driver TLS/SSL Trust Store Password

Description
The password for the SRM Driver 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
ssl.truststore.password
Default Value
API Name
ssl_client_truststore_password
Required
false

Enable TLS/SSL for SRM Driver

Description
Encrypt communication between clients and SRM Driver 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

SRM Driver TLS/SSL Server Keystore Key Password

Description
The password that protects the private key contained in the keystore used when SRM Driver is acting as a TLS/SSL server.
Related Name
ssl.key.password
Default Value
API Name
ssl_server_keystore_keypassword
Required
false

SRM Driver 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 SRM Driver is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name
ssl.keystore.location
Default Value
API Name
ssl_server_keystore_location
Required
false

SRM Driver TLS/SSL Server Keystore File Password

Description
The password for the SRM Driver keystore file.
Related Name
ssl.keystore.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.
Related Name
Default Value
false
API Name
role_config_suppression_cdh_version_validator
Required
true

Suppress Parameter Validation: SRM Driver Log Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver Log Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_log_dir
Required
true

Suppress Parameter Validation: SRM Driver XML Override

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver XML Override parameter.
Related Name
Default Value
false
API Name
role_config_suppression_logback_safety_valve
Required
true

Suppress Parameter Validation: Heap Dump Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_oom_heap_dump_dir
Required
true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_rm_custom_resources
Required
true

Suppress Parameter Validation: Role Triggers

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value
false
API Name
role_config_suppression_role_triggers
Required
true

Suppress Parameter Validation: SRM Driver Advanced Configuration Snippet (Safety Valve) for srm.properties

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver Advanced Configuration Snippet (Safety Valve) for srm.properties parameter.
Related Name
Default Value
false
API Name
role_config_suppression_srm.properties_role_safety_valve
Required
true

Suppress Parameter Validation: SRM Driver TLS/SSL Trust Store File

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver TLS/SSL Trust Store File parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_location
Required
true

Suppress Parameter Validation: SRM Driver TLS/SSL Trust Store Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver TLS/SSL Trust Store Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_password
Required
true

Suppress Parameter Validation: SRM Driver TLS/SSL Server Keystore Key Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver TLS/SSL Server Keystore Key Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_keypassword
Required
true

Suppress Parameter Validation: SRM Driver TLS/SSL Server Keystore File Location

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver TLS/SSL Server Keystore File Location parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_location
Required
true

Suppress Parameter Validation: SRM Driver TLS/SSL Server Keystore File Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_password
Required
true

Suppress Parameter Validation: Stacks Collection Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_stacks_collection_directory
Required
true

Suppress Parameter Validation: Streams Replication Manager Driver Target Cluster

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Replication Manager Driver Target Cluster parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.driver.target.cluster
Required
true

Suppress Parameter Validation: Java Home Path Override

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Home Path Override parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.jdk.home
Required
true

Suppress Parameter Validation: SRM Driver Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams_replication_manager_driver_role_env_safety_valve
Required
true

Suppress Health Test: Audit Pipeline Test

Description
Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_driver_audit_health
Required
true

Suppress Health Test: File Descriptors

Description
Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_driver_file_descriptor
Required
true

Suppress Health Test: Host Health

Description
Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_driver_host_health
Required
true

Suppress Health Test: Log Directory Free Space

Description
Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_driver_log_directory_free_space
Required
true

Suppress Health Test: Process Status

Description
Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_driver_scm_health
Required
true

Suppress Health Test: Swap Memory Usage

Description
Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_driver_swap_memory_usage
Required
true

Suppress Health Test: Swap Memory Usage Rate Beta

Description
Whether to suppress the results of the Swap Memory Usage Rate Beta heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_driver_swap_memory_usage_rate
Required
true

Suppress Health Test: Unexpected Exits

Description
Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_driver_unexpected_exits
Required
true

SRM Service

Advanced

SRM Service XML Override

Description
For advanced use only, replace entire XML in the logback configuration file for SRM Service, 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

SRM Service Advanced Configuration Snippet (Safety Valve) for srm-service.yaml

Description
For advanced use only. A string to be inserted into srm-service.yaml for this role only.
Related Name
Default Value
API Name
srm-service.yaml_role_safety_valve
Required
false

SRM Service Advanced Configuration Snippet (Safety Valve) for srm.properties

Description
For advanced use only. A string to be inserted into srm.properties for this role only.
Related Name
Default Value
API Name
srm.properties_role_safety_valve
Required
false

SRM 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 this role except client configuration.
Related Name
Default Value
API Name
STREAMS_REPLICATION_MANAGER_SERVICE_role_env_safety_valve
Required
false

Logs

SRM Service Log Directory

Description
The log directory for log files of the role SRM Service.
Related Name
log_dir
Default Value
/var/log/streams-replication-manager
API Name
log_dir
Required
false

SRM Service Logging Threshold

Description
The minimum log level for SRM Service logs
Related Name
Default Value
INFO
API Name
log_threshold
Required
false

SRM Service Maximum Log File Backups

Description
The maximum number of rolled log files to keep for SRM Service logs. Typically used by log4j or logback.
Related Name
Default Value
10
API Name
max_log_backup_index
Required
false

SRM Service Max Log Size

Description
The maximum size, in megabytes, per log file for SRM Service 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
streams_replication_manager_service_fd_thresholds
Required
false

SRM Service Host Health Test

Description
When computing the overall SRM Service health, consider the host's health.
Related Name
Default Value
true
API Name
streams_replication_manager_service_host_health_enabled
Required
false

SRM Service Process Health Test

Description
Enables the health test that the SRM Service's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
streams_replication_manager_service_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

Log Format

Description
Format of the messages output by logger.
Related Name
streams.replication.manager.log.format
Default Value
%dISO8601 %p %c: %m%n%rEx
API Name
streams.replication.manager.log.format
Required
false

SRM Service Port

Description
SRM Service port.
Related Name
streams.replication.manager.service.port
Default Value
6670
API Name
streams.replication.manager.service.port
Required
true

SRM Service Rpc Port

Description
SRM Service rpc port.
Related Name
streams.replication.manager.service.rpcPort
Default Value
6670
API Name
streams.replication.manager.service.rpcPort
Required
true

SRM Service Https Port

Description
SRM Service https port.
Related Name
streams.replication.manager.service.ssl.port
Default Value
6671
API Name
streams.replication.manager.service.ssl.port
Required
true

Streams Replication Manager Service Target Cluster

Description
Target cluster from which the SRM Service collects data.
Related Name
streams.replication.manager.service.target.cluster
Default Value
API Name
streams.replication.manager.service.target.cluster
Required
true

SSL Keystore Type

Description
The keystore type. Required if SSL is enabled for the SRM Service. For example, PKCS12 or JKS.
Related Name
streams.replication.manager.ssl.keyStoreType
Default Value
JKS
API Name
streams.replication.manager.ssl.keyStoreType
Required
false

SSL TrustStore Type

Description
The truststore type. Required if SSL is enabled for the SRM Service. For example, PKCS12 or JKS.
Related Name
streams.replication.manager.ssl.trustStoreType
Default Value
JKS
API Name
streams.replication.manager.ssl.trustStoreType
Required
false

SSL ValidateCerts

Description
Whether or not to validate TLS certificates before starting. If enabled, SRM will not start with expired or otherwise invalid certificates.
Related Name
streams.replication.manager.ssl.validateCerts
Default Value
false
API Name
streams.replication.manager.ssl.validateCerts
Required
false

SSL ValidatePeers

Description
Whether or not to validate TLS peer certificates.
Related Name
streams.replication.manager.ssl.validatePeers
Default Value
false
API Name
streams.replication.manager.ssl.validatePeers
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

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

SRM Service 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 SRM Service 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
ssl.truststore.location
Default Value
API Name
ssl_client_truststore_location
Required
false

SRM Service TLS/SSL Trust Store Password

Description
The password for the SRM Service 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
ssl.truststore.password
Default Value
API Name
ssl_client_truststore_password
Required
false

Enable TLS/SSL for SRM Service

Description
Encrypt communication between clients and SRM Service 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

SRM Service TLS/SSL Server Keystore Key Password

Description
The password that protects the private key contained in the keystore used when SRM Service is acting as a TLS/SSL server.
Related Name
ssl.key.password
Default Value
API Name
ssl_server_keystore_keypassword
Required
false

SRM Service 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 SRM Service is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name
ssl.keystore.location
Default Value
API Name
ssl_server_keystore_location
Required
false

SRM Service TLS/SSL Server Keystore File Password

Description
The password for the SRM Service keystore file.
Related Name
ssl.keystore.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.
Related Name
Default Value
false
API Name
role_config_suppression_cdh_version_validator
Required
true

Suppress Parameter Validation: SRM Service Log Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service Log Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_log_dir
Required
true

Suppress Parameter Validation: SRM Service XML Override

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service XML Override parameter.
Related Name
Default Value
false
API Name
role_config_suppression_logback_safety_valve
Required
true

Suppress Parameter Validation: Heap Dump Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_oom_heap_dump_dir
Required
true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_rm_custom_resources
Required
true

Suppress Parameter Validation: Role Triggers

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value
false
API Name
role_config_suppression_role_triggers
Required
true

Suppress Parameter Validation: SRM Service Advanced Configuration Snippet (Safety Valve) for srm-service.yaml

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service Advanced Configuration Snippet (Safety Valve) for srm-service.yaml parameter.
Related Name
Default Value
false
API Name
role_config_suppression_srm-service.yaml_role_safety_valve
Required
true

Suppress Parameter Validation: SRM Service Advanced Configuration Snippet (Safety Valve) for srm.properties

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service Advanced Configuration Snippet (Safety Valve) for srm.properties parameter.
Related Name
Default Value
false
API Name
role_config_suppression_srm.properties_role_safety_valve
Required
true

Suppress Parameter Validation: SRM Service TLS/SSL Trust Store File

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service TLS/SSL Trust Store File parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_location
Required
true

Suppress Parameter Validation: SRM Service TLS/SSL Trust Store Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service TLS/SSL Trust Store Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_password
Required
true

Suppress Parameter Validation: SRM Service TLS/SSL Server Keystore Key Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service TLS/SSL Server Keystore Key Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_keypassword
Required
true

Suppress Parameter Validation: SRM Service TLS/SSL Server Keystore File Location

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service TLS/SSL Server Keystore File Location parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_location
Required
true

Suppress Parameter Validation: SRM Service TLS/SSL Server Keystore File Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_password
Required
true

Suppress Parameter Validation: Stacks Collection Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_stacks_collection_directory
Required
true

Suppress Parameter Validation: Log Format

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Log Format parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.log.format
Required
true

Suppress Parameter Validation: SRM Service Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.service.port
Required
true

Suppress Parameter Validation: SRM Service Rpc Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service Rpc Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.service.rpcport
Required
true

Suppress Parameter Validation: SRM Service Https Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service Https Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.service.ssl.port
Required
true

Suppress Parameter Validation: Streams Replication Manager Service Target Cluster

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Replication Manager Service Target Cluster parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.service.target.cluster
Required
true

Suppress Parameter Validation: SSL Keystore Type

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL Keystore Type parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.ssl.keystoretype
Required
true

Suppress Parameter Validation: SSL TrustStore Type

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL TrustStore Type parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.ssl.truststoretype
Required
true

Suppress Parameter Validation: SSL ValidateCerts

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL ValidateCerts parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.ssl.validatecerts
Required
true

Suppress Parameter Validation: SSL ValidatePeers

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL ValidatePeers parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.ssl.validatepeers
Required
true

Suppress Parameter Validation: SRM Service Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams_replication_manager_service_role_env_safety_valve
Required
true

Suppress Health Test: Audit Pipeline Test

Description
Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_service_audit_health
Required
true

Suppress Health Test: File Descriptors

Description
Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_service_file_descriptor
Required
true

Suppress Health Test: Host Health

Description
Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_service_host_health
Required
true

Suppress Health Test: Log Directory Free Space

Description
Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_service_log_directory_free_space
Required
true

Suppress Health Test: Process Status

Description
Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_service_scm_health
Required
true

Suppress Health Test: Swap Memory Usage

Description
Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_service_swap_memory_usage
Required
true

Suppress Health Test: Swap Memory Usage Rate Beta

Description
Whether to suppress the results of the Swap Memory Usage Rate Beta heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_service_swap_memory_usage_rate
Required
true

Suppress Health Test: Unexpected Exits

Description
Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_streams_replication_manager_streams_replication_manager_service_unexpected_exits
Required
true