Streams Replication Manager Properties in Cloudera Runtime 7.2.1

Role groups:

Gateway

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Deploy Directory The directory where the client configs will be deployed /etc/streams_replication_manager client_config_root_dir true
Streams Replication Manager Client Advanced Configuration Snippet (Safety Valve) for srm-client-conf/srm.properties For advanced use only, a string to be inserted into the client configuration for srm-client-conf/srm.properties. srm-client-conf/srm.properties_client_config_safety_valve false

Monitoring

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

Other

Display Name Description Related Name Default Value API Name Required
Alternatives Priority The priority level that the client configuration will have in the Alternatives system on the hosts. Higher priority levels will cause Alternatives to prefer this configuration over any others. 50 client_config_priority true

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Deploy Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Deploy Directory parameter. false role_config_suppression_client_config_root_dir true
Suppress Parameter Validation: Streams Replication Manager Client Advanced Configuration Snippet (Safety Valve) for srm-client-conf/srm.properties Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Replication Manager Client Advanced Configuration Snippet (Safety Valve) for srm-client-conf/srm.properties parameter. false role_config_suppression_srm-client-conf/srm.properties_client_config_safety_valve true

Service-Wide

Categories:

Advanced

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

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Service Level Health Alerts When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Service Triggers The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific service.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger fires if there are more than 10 DataNodes with more than 500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad", "streamThreshold": 10, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
[] service_triggers true
Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones. smon_derived_configs_safety_valve false
SRM Driver Role Health Test When computing the overall STREAMS_REPLICATION_MANAGER health, consider SRM Driver's health true STREAMS_REPLICATION_MANAGER_STREAMS_REPLICATION_MANAGER_DRIVER_health_enabled false
SRM Service Role Health Test When computing the overall STREAMS_REPLICATION_MANAGER health, consider SRM Service's health true STREAMS_REPLICATION_MANAGER_STREAMS_REPLICATION_MANAGER_SERVICE_health_enabled false

Other

Display Name Description Related Name Default Value API Name Required
Streams Replication Manager Cluster alias Specifies cluster aliases for the clusters SRM is connecting to. Cluster aliases are comma delimited. For example, 'primary, backup'. clusters clusters true
Emit Checkpoints Interval Seconds The interval at which SRM emits checkpoint information. emit.checkpoints.interval.seconds 5 second(s) emit.checkpoints.interval.seconds true
Kafka Service Name of the Kafka service that this Streams Replication Manager service instance depends on kafka_service false
Enable Kerberos Authentication Enables Kerberos authentication for this Streams Replication Manager. kerberos.auth.enable false kerberos.auth.enable false
Replication Factor for Metrics Topics Replication factor for all metrics topics. metrics.topic.replication.factor 3 metrics.topic.replication.factor false
Refresh Groups Interval Seconds The interval at which SRM looks for new consumer groups on source clusters. refresh.groups.interval.seconds 10 minute(s) refresh.groups.interval.seconds true
Refresh Topics Interval Seconds The interval at which SRM looks for new topics on source clusters. refresh.topics.interval.seconds 10 minute(s) refresh.topics.interval.seconds true
SRM_HEAP_OPTS Memory heap params. SRM_HEAP_OPTS -Xmx8G -Xms1G SRM_HEAP_OPTS false
SRM_JMX_OPTS Change parameters to setup jmxremote. SRM_JMX_OPTS -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false SRM_JMX_OPTS false
SRM_JVM_PERF_OPTS SRM JVM perf and gc opts. SRM_JVM_PERF_OPTS -server -XX:+UseG1GC -XX:MaxGCPauseMillis=20 -XX:InitiatingHeapOccupancyPercent=35 -XX:+ExplicitGCInvokesConcurrent -Djava.awt.headless=true SRM_JVM_PERF_OPTS false
Streams Replication Manager's Replication Configs 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. streams.replication.manager.config streams.replication.manager.config true
Sync Topic Acls Enabled Enables the monitoring of the source cluster for ACL changes. sync.topic.acls.enabled false sync.topic.acls.enabled true
Sync Topic Acls Interval Seconds The interval at which SRM checks the source cluster for ACL changes. sync.topic.acls.interval.seconds 30 second(s) sync.topic.acls.interval.seconds true
Sync Topic Configs Interval Seconds The interval at which SRM checks the source cluster for configuration changes. sync.topic.configs.interval.seconds 10 minute(s) sync.topic.configs.interval.seconds true
Tasks Max Maximum number of tasks for replication between clusters. tasks.max 3 tasks.max true

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Configuration Validator: Deploy Directory Whether to suppress configuration warnings produced by the Deploy Directory configuration validator. false role_config_suppression_client_config_root_dir true
Suppress Configuration Validator: SRM Driver Log Directory Whether to suppress configuration warnings produced by the SRM Driver Log Directory configuration validator. false role_config_suppression_log_dir true
Suppress Configuration Validator: SRM Driver XML Override Whether to suppress configuration warnings produced by the SRM Driver XML Override configuration validator. false role_config_suppression_logback_safety_valve true
Suppress Configuration Validator: Heap Dump Directory Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator. false role_config_suppression_oom_heap_dump_dir true
Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator. false role_config_suppression_rm_custom_resources true
Suppress Configuration Validator: Role Triggers Whether to suppress configuration warnings produced by the Role Triggers configuration validator. false role_config_suppression_role_triggers true
Suppress Configuration Validator: Streams Replication Manager Client Advanced Configuration Snippet (Safety Valve) for srm-client-conf/srm.properties Whether to suppress configuration warnings produced by the Streams Replication Manager Client Advanced Configuration Snippet (Safety Valve) for srm-client-conf/srm.properties configuration validator. false role_config_suppression_srm-client-conf/srm.properties_client_config_safety_valve true
Suppress Configuration Validator: SRM Service Advanced Configuration Snippet (Safety Valve) for srm-service.yaml Whether to suppress configuration warnings produced by the SRM Service Advanced Configuration Snippet (Safety Valve) for srm-service.yaml configuration validator. false role_config_suppression_srm-service.yaml_role_safety_valve true
Suppress Configuration Validator: SRM Driver Advanced Configuration Snippet (Safety Valve) for srm.properties Whether to suppress configuration warnings produced by the SRM Driver Advanced Configuration Snippet (Safety Valve) for srm.properties configuration validator. false role_config_suppression_srm.properties_role_safety_valve true
Suppress Configuration Validator: SRM Driver TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the SRM Driver TLS/SSL Client Trust Store File configuration validator. false role_config_suppression_ssl_client_truststore_location true
Suppress Configuration Validator: SRM Driver TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the SRM Driver TLS/SSL Client Trust Store Password configuration validator. false role_config_suppression_ssl_client_truststore_password true
Suppress Configuration Validator: SRM Driver TLS/SSL Server JKS Keystore Key Password Whether to suppress configuration warnings produced by the SRM Driver TLS/SSL Server JKS Keystore Key Password configuration validator. false role_config_suppression_ssl_server_keystore_keypassword true
Suppress Configuration Validator: SRM Driver TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the SRM Driver TLS/SSL Server JKS Keystore File Location configuration validator. false role_config_suppression_ssl_server_keystore_location true
Suppress Configuration Validator: SRM Driver TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the SRM Driver TLS/SSL Server JKS Keystore File Password configuration validator. false role_config_suppression_ssl_server_keystore_password true
Suppress Configuration Validator: Stacks Collection Directory Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator. false role_config_suppression_stacks_collection_directory true
Suppress Configuration Validator: Streams Replication Manager Driver Target Cluster Whether to suppress configuration warnings produced by the Streams Replication Manager Driver Target Cluster configuration validator. false role_config_suppression_streams.replication.manager.driver.target.cluster true
Suppress Configuration Validator: Java Home Path Override Whether to suppress configuration warnings produced by the Java Home Path Override configuration validator. false role_config_suppression_streams.replication.manager.jdk.home true
Suppress Configuration Validator: Log Format Whether to suppress configuration warnings produced by the Log Format configuration validator. false role_config_suppression_streams.replication.manager.log.format true
Suppress Configuration Validator: SRM Service Port Whether to suppress configuration warnings produced by the SRM Service Port configuration validator. false role_config_suppression_streams.replication.manager.service.port true
Suppress Configuration Validator: SRM Service Rpc Port Whether to suppress configuration warnings produced by the SRM Service Rpc Port configuration validator. false role_config_suppression_streams.replication.manager.service.rpcport true
Suppress Configuration Validator: SRM Service Https Port Whether to suppress configuration warnings produced by the SRM Service Https Port configuration validator. false role_config_suppression_streams.replication.manager.service.ssl.port true
Suppress Configuration Validator: Streams Replication Manager Service Target Cluster Whether to suppress configuration warnings produced by the Streams Replication Manager Service Target Cluster configuration validator. false role_config_suppression_streams.replication.manager.service.target.cluster true
Suppress Configuration Validator: SSL Keystore Type Whether to suppress configuration warnings produced by the SSL Keystore Type configuration validator. false role_config_suppression_streams.replication.manager.ssl.keystoretype true
Suppress Configuration Validator: SSL TrustStore Type Whether to suppress configuration warnings produced by the SSL TrustStore Type configuration validator. false role_config_suppression_streams.replication.manager.ssl.truststoretype true
Suppress Configuration Validator: SSL ValidateCerts Whether to suppress configuration warnings produced by the SSL ValidateCerts configuration validator. false role_config_suppression_streams.replication.manager.ssl.validatecerts true
Suppress Configuration Validator: SSL ValidatePeers Whether to suppress configuration warnings produced by the SSL ValidatePeers configuration validator. false role_config_suppression_streams.replication.manager.ssl.validatepeers true
Suppress Configuration Validator: SRM Driver Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the SRM Driver Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_streams_replication_manager_driver_role_env_safety_valve true
Suppress Configuration Validator: SRM Service Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the SRM Service Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_streams_replication_manager_service_role_env_safety_valve true
Suppress Parameter Validation: Streams Replication Manager Cluster alias Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Replication Manager Cluster alias parameter. false service_config_suppression_clusters true
Suppress Configuration Validator: Gateway Count Validator Whether to suppress configuration warnings produced by the Gateway Count Validator configuration validator. false service_config_suppression_gateway_count_validator true
Suppress Parameter Validation: Replication Factor for Metrics Topics Whether to suppress configuration warnings produced by the built-in parameter validation for the Replication Factor for Metrics Topics parameter. false service_config_suppression_metrics.topic.replication.factor true
Suppress Parameter Validation: System Group Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter. false service_config_suppression_process_groupname true
Suppress Parameter Validation: System User Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter. false service_config_suppression_process_username true
Suppress Parameter Validation: Service Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter. false service_config_suppression_service_triggers true
Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter. false service_config_suppression_smon_derived_configs_safety_valve true
Suppress Parameter Validation: Streams Replication Manager Service Advanced Configuration Snippet (Safety Valve) for srm.properties 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. false service_config_suppression_srm.properties_service_safety_valve true
Suppress Parameter Validation: SRM_HEAP_OPTS Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM_HEAP_OPTS parameter. false service_config_suppression_srm_heap_opts true
Suppress Parameter Validation: SRM_JMX_OPTS Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM_JMX_OPTS parameter. false service_config_suppression_srm_jmx_opts true
Suppress Parameter Validation: SRM_JVM_PERF_OPTS Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM_JVM_PERF_OPTS parameter. false service_config_suppression_srm_jvm_perf_opts true
Suppress Parameter Validation: Streams Replication Manager's Replication Configs Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Replication Manager's Replication Configs parameter. false service_config_suppression_streams.replication.manager.config true
Suppress Configuration Validator: SRM Driver Count Validator Whether to suppress configuration warnings produced by the SRM Driver Count Validator configuration validator. false service_config_suppression_streams_replication_manager_driver_count_validator true
Suppress Configuration Validator: SRM Service Count Validator Whether to suppress configuration warnings produced by the SRM Service Count Validator configuration validator. false service_config_suppression_streams_replication_manager_service_count_validator true
Suppress Parameter Validation: Streams Replication Manager Service Environment Advanced Configuration Snippet (Safety Valve) 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. false service_config_suppression_streams_replication_manager_service_env_safety_valve true
Suppress Health Test: SRM Driver Health 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. false service_health_suppression_streams_replication_manager_streams_replication_manager_streams_replication_manager_driver_health true
Suppress Health Test: SRM Service Health 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. false service_health_suppression_streams_replication_manager_streams_replication_manager_streams_replication_manager_service_health true

SRM Driver

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
SRM Driver XML Override For advanced use only, replace entire XML in the logback configuration file for SRM Driver, ignoring all logging configuration. logback_safety_valve logback_safety_valve false
Heap Dump Directory Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role. oom_heap_dump_dir /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. true oom_heap_dump_enabled true
Kill When Out of Memory When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. true oom_sigkill_enabled true
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. false process_auto_restart true
Enable Metric Collection Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. true process_should_monitor true
Process Start Retry Attempts Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. 3 process_start_retries false
Process Start Wait Timeout The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. 20 process_start_secs false
SRM Driver Advanced Configuration Snippet (Safety Valve) for srm.properties For advanced use only. A string to be inserted into srm.properties for this role only. srm.properties_role_safety_valve false
SRM Driver Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. STREAMS_REPLICATION_MANAGER_DRIVER_role_env_safety_valve false

Logs

Display Name Description Related Name Default Value API Name Required
SRM Driver Log Directory The log directory for log files of the role SRM Driver. log_dir /var/log/streams-replication-manager log_dir false
SRM Driver Logging Threshold The minimum log level for SRM Driver logs INFO log_threshold false
SRM Driver Maximum Log File Backups The maximum number of rolled log files to keep for SRM Driver logs. Typically used by log4j or logback. 10 max_log_backup_index false
SRM Driver Max Log Size The maximum size, in megabytes, per log file for SRM Driver logs. Typically used by log4j or logback. 200 MiB max_log_size false

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Metric Filter Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
monitoring_metric_filter false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. Warning: 200 B, Critical: Never process_swap_memory_thresholds false
Role Triggers The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
[] role_triggers true
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % streams_replication_manager_driver_fd_thresholds false
SRM Driver Host Health Test When computing the overall SRM Driver health, consider the host's health. true streams_replication_manager_driver_host_health_enabled false
SRM Driver Process Health Test Enables the health test that the SRM Driver's process state is consistent with the role configuration true streams_replication_manager_driver_scm_health_enabled false
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

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

Performance

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

Resource Management

Display Name Description Related Name Default Value API Name Required
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Custom Control Group Resources (overrides Cgroup settings) Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.*** custom.cgroups rm_custom_resources false
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true

Security

Display Name Description Related Name Default Value API Name Required
SRM Driver TLS/SSL Client Trust Store File The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that SRM Driver might connect to. This is used when SRM Driver 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. ssl.truststore.location ssl_client_truststore_location false
SRM Driver TLS/SSL Client Trust Store Password The password for the SRM Driver TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. ssl.truststore.password ssl_client_truststore_password false
Enable TLS/SSL for SRM Driver Encrypt communication between clients and SRM Driver using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). ssl_enabled false ssl_enabled false
SRM Driver TLS/SSL Server JKS Keystore Key Password The password that protects the private key contained in the JKS keystore used when SRM Driver is acting as a TLS/SSL server. ssl.key.password ssl_server_keystore_keypassword false
SRM Driver TLS/SSL Server JKS Keystore File Location The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when SRM Driver is acting as a TLS/SSL server. The keystore must be in JKS format. ssl.keystore.location ssl_server_keystore_location false
SRM Driver TLS/SSL Server JKS Keystore File Password The password for the SRM Driver JKS keystore file. ssl.keystore.password ssl_server_keystore_password false

Stacks Collection

Display Name Description Related Name Default Value API Name Required
Stacks Collection Data Retention The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. stacks_collection_data_retention 100 MiB stacks_collection_data_retention false
Stacks Collection Directory The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. stacks_collection_directory stacks_collection_directory false
Stacks Collection Enabled Whether or not periodic stacks collection is enabled. stacks_collection_enabled false stacks_collection_enabled true
Stacks Collection Frequency The frequency with which stacks are collected. stacks_collection_frequency 5.0 second(s) stacks_collection_frequency false
Stacks Collection Method The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped. stacks_collection_method jstack stacks_collection_method false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: SRM Driver Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: SRM Driver XML Override Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver XML Override parameter. false role_config_suppression_logback_safety_valve true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: SRM Driver Advanced Configuration Snippet (Safety Valve) for srm.properties 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. false role_config_suppression_srm.properties_role_safety_valve true
Suppress Parameter Validation: SRM Driver TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: SRM Driver TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: SRM Driver TLS/SSL Server JKS Keystore Key Password Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver TLS/SSL Server JKS Keystore Key Password parameter. false role_config_suppression_ssl_server_keystore_keypassword true
Suppress Parameter Validation: SRM Driver TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: SRM Driver TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver TLS/SSL Server JKS Keystore File Password parameter. false role_config_suppression_ssl_server_keystore_password true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Parameter Validation: Streams Replication Manager Driver Target Cluster Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Replication Manager Driver Target Cluster parameter. false role_config_suppression_streams.replication.manager.driver.target.cluster true
Suppress Parameter Validation: Java Home Path Override Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Home Path Override parameter. false role_config_suppression_streams.replication.manager.jdk.home true
Suppress Parameter Validation: SRM Driver Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Driver Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_streams_replication_manager_driver_role_env_safety_valve true
Suppress Health Test: Audit Pipeline Test Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_replication_manager_streams_replication_manager_driver_audit_health true
Suppress Health Test: File Descriptors Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_replication_manager_streams_replication_manager_driver_file_descriptor true
Suppress Health Test: Host Health Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_replication_manager_streams_replication_manager_driver_host_health true
Suppress Health Test: Log Directory Free Space Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_replication_manager_streams_replication_manager_driver_log_directory_free_space true
Suppress Health Test: Process Status Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_replication_manager_streams_replication_manager_driver_scm_health true
Suppress Health Test: Swap Memory Usage Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_replication_manager_streams_replication_manager_driver_swap_memory_usage true
Suppress Health Test: Unexpected Exits Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_replication_manager_streams_replication_manager_driver_unexpected_exits true

SRM Service

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
SRM Service XML Override For advanced use only, replace entire XML in the logback configuration file for SRM Service, ignoring all logging configuration. logback_safety_valve logback_safety_valve false
Heap Dump Directory Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role. oom_heap_dump_dir /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. true oom_heap_dump_enabled true
Kill When Out of Memory When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. true oom_sigkill_enabled true
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. false process_auto_restart true
Enable Metric Collection Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. true process_should_monitor true
Process Start Retry Attempts Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. 3 process_start_retries false
Process Start Wait Timeout The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. 20 process_start_secs false
SRM Service Advanced Configuration Snippet (Safety Valve) for srm-service.yaml For advanced use only. A string to be inserted into srm-service.yaml for this role only. srm-service.yaml_role_safety_valve false
SRM Service Advanced Configuration Snippet (Safety Valve) for srm.properties For advanced use only. A string to be inserted into srm.properties for this role only. srm.properties_role_safety_valve false
SRM Service Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. STREAMS_REPLICATION_MANAGER_SERVICE_role_env_safety_valve false

Logs

Display Name Description Related Name Default Value API Name Required
SRM Service Log Directory The log directory for log files of the role SRM Service. log_dir /var/log/streams-replication-manager log_dir false
SRM Service Logging Threshold The minimum log level for SRM Service logs INFO log_threshold false
SRM Service Maximum Log File Backups The maximum number of rolled log files to keep for SRM Service logs. Typically used by log4j or logback. 10 max_log_backup_index false
SRM Service Max Log Size The maximum size, in megabytes, per log file for SRM Service logs. Typically used by log4j or logback. 200 MiB max_log_size false

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Metric Filter Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
monitoring_metric_filter false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. Warning: 200 B, Critical: Never process_swap_memory_thresholds false
Role Triggers The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
[] role_triggers true
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % streams_replication_manager_service_fd_thresholds false
SRM Service Host Health Test When computing the overall SRM Service health, consider the host's health. true streams_replication_manager_service_host_health_enabled false
SRM Service Process Health Test Enables the health test that the SRM Service's process state is consistent with the role configuration true streams_replication_manager_service_scm_health_enabled false
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value API Name Required
Log Format Format of the messages output by logger. streams.replication.manager.log.format %dISO8601 %p %c: %m%n%rEx streams.replication.manager.log.format false
SRM Service Port SRM Service port. streams.replication.manager.service.port 6670 streams.replication.manager.service.port true
SRM Service Rpc Port SRM Service rpc port. streams.replication.manager.service.rpcPort 6670 streams.replication.manager.service.rpcPort true
SRM Service Https Port SRM Service https port. streams.replication.manager.service.ssl.port 6671 streams.replication.manager.service.ssl.port true
Streams Replication Manager Service Target Cluster Target cluster from which the SRM Service collects data. streams.replication.manager.service.target.cluster streams.replication.manager.service.target.cluster true
SSL Keystore Type The keystore type. Required if SSL is enabled for the SRM Service. For example, PKCS12 or JKS. streams.replication.manager.ssl.keyStoreType JKS streams.replication.manager.ssl.keyStoreType false
SSL TrustStore Type The truststore type. Required if SSL is enabled for the SRM Service. For example, PKCS12 or JKS. streams.replication.manager.ssl.trustStoreType JKS streams.replication.manager.ssl.trustStoreType false
SSL ValidateCerts Whether or not to validate TLS certificates before starting. If enabled, SRM will not start with expired or otherwise invalid certificates. streams.replication.manager.ssl.validateCerts false streams.replication.manager.ssl.validateCerts false
SSL ValidatePeers Whether or not to validate TLS peer certificates. streams.replication.manager.ssl.validatePeers false streams.replication.manager.ssl.validatePeers false

Performance

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

Resource Management

Display Name Description Related Name Default Value API Name Required
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Custom Control Group Resources (overrides Cgroup settings) Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.*** custom.cgroups rm_custom_resources false
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true

Security

Display Name Description Related Name Default Value API Name Required
SRM Service TLS/SSL Client Trust Store File The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that SRM Service might connect to. This is used when SRM Service 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. ssl.truststore.location ssl_client_truststore_location false
SRM Service TLS/SSL Client Trust Store Password The password for the SRM Service TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. ssl.truststore.password ssl_client_truststore_password false
Enable TLS/SSL for SRM Service Encrypt communication between clients and SRM Service using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). ssl_enabled false ssl_enabled false
SRM Service TLS/SSL Server JKS Keystore Key Password The password that protects the private key contained in the JKS keystore used when SRM Service is acting as a TLS/SSL server. ssl.key.password ssl_server_keystore_keypassword false
SRM Service TLS/SSL Server JKS Keystore File Location The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when SRM Service is acting as a TLS/SSL server. The keystore must be in JKS format. ssl.keystore.location ssl_server_keystore_location false
SRM Service TLS/SSL Server JKS Keystore File Password The password for the SRM Service JKS keystore file. ssl.keystore.password ssl_server_keystore_password false

Stacks Collection

Display Name Description Related Name Default Value API Name Required
Stacks Collection Data Retention The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. stacks_collection_data_retention 100 MiB stacks_collection_data_retention false
Stacks Collection Directory The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. stacks_collection_directory stacks_collection_directory false
Stacks Collection Enabled Whether or not periodic stacks collection is enabled. stacks_collection_enabled false stacks_collection_enabled true
Stacks Collection Frequency The frequency with which stacks are collected. stacks_collection_frequency 5.0 second(s) stacks_collection_frequency false
Stacks Collection Method The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped. stacks_collection_method jstack stacks_collection_method false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: SRM Service Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: SRM Service XML Override Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service XML Override parameter. false role_config_suppression_logback_safety_valve true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: SRM Service Advanced Configuration Snippet (Safety Valve) for srm-service.yaml 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. false role_config_suppression_srm-service.yaml_role_safety_valve true
Suppress Parameter Validation: SRM Service Advanced Configuration Snippet (Safety Valve) for srm.properties 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. false role_config_suppression_srm.properties_role_safety_valve true
Suppress Parameter Validation: SRM Service TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: SRM Service TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: SRM Service TLS/SSL Server JKS Keystore Key Password Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service TLS/SSL Server JKS Keystore Key Password parameter. false role_config_suppression_ssl_server_keystore_keypassword true
Suppress Parameter Validation: SRM Service TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: SRM Service TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service TLS/SSL Server JKS Keystore File Password parameter. false role_config_suppression_ssl_server_keystore_password true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Parameter Validation: Log Format Whether to suppress configuration warnings produced by the built-in parameter validation for the Log Format parameter. false role_config_suppression_streams.replication.manager.log.format true
Suppress Parameter Validation: SRM Service Port Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service Port parameter. false role_config_suppression_streams.replication.manager.service.port true
Suppress Parameter Validation: SRM Service Rpc Port Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service Rpc Port parameter. false role_config_suppression_streams.replication.manager.service.rpcport true
Suppress Parameter Validation: SRM Service Https Port Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service Https Port parameter. false role_config_suppression_streams.replication.manager.service.ssl.port true
Suppress Parameter Validation: Streams Replication Manager Service Target Cluster Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Replication Manager Service Target Cluster parameter. false role_config_suppression_streams.replication.manager.service.target.cluster true
Suppress Parameter Validation: SSL Keystore Type Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL Keystore Type parameter. false role_config_suppression_streams.replication.manager.ssl.keystoretype true
Suppress Parameter Validation: SSL TrustStore Type Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL TrustStore Type parameter. false role_config_suppression_streams.replication.manager.ssl.truststoretype true
Suppress Parameter Validation: SSL ValidateCerts Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL ValidateCerts parameter. false role_config_suppression_streams.replication.manager.ssl.validatecerts true
Suppress Parameter Validation: SSL ValidatePeers Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL ValidatePeers parameter. false role_config_suppression_streams.replication.manager.ssl.validatepeers true
Suppress Parameter Validation: SRM Service Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the SRM Service Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_streams_replication_manager_service_role_env_safety_valve true
Suppress Health Test: Audit Pipeline Test Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_replication_manager_streams_replication_manager_service_audit_health true
Suppress Health Test: File Descriptors Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_replication_manager_streams_replication_manager_service_file_descriptor true
Suppress Health Test: Host Health Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_replication_manager_streams_replication_manager_service_host_health true
Suppress Health Test: Log Directory Free Space Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_replication_manager_streams_replication_manager_service_log_directory_free_space true
Suppress Health Test: Process Status Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_replication_manager_streams_replication_manager_service_scm_health true
Suppress Health Test: Swap Memory Usage Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_replication_manager_streams_replication_manager_service_swap_memory_usage true
Suppress Health Test: Unexpected Exits Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_replication_manager_streams_replication_manager_service_unexpected_exits true