Streams Messaging Manager Properties in Cloudera Runtime 7.1

Role groups:

Service-Wide

Advanced

System Group

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

System User

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

Streams Messaging 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_MESSAGING_MANAGER_service_env_safety_valve
Required
false

Database

Streams Messaging Manager Database Host

Description
Hostname of the database used by Streams Messaging Manager. If the port is non-default for your database type, use host:port notation.
Related Name
streams.messaging.manager.storage.connector.host
Default Value
localhost
API Name
smm_database_host
Required
true

Streams Messaging Manager Database Name

Description
Name of Streams Messaging Manager database.
Related Name
streams.messaging.manager.storage.connector.name
Default Value
streamsmsgmgr
API Name
smm_database_name
Required
true

Streams Messaging Manager Database User Password

Description
Password for Streams Messaging Manager database.
Related Name
streams.messaging.manager.storage.connector.password
Default Value
API Name
smm_database_password
Required
true

Streams Messaging Manager Database Port

Description
Port for Streams Messaging Manager database.
Related Name
streams.messaging.manager.storage.connector.port
Default Value
3306
API Name
smm_database_port
Required
true

Streams Messaging Manager Database Type

Description
Database type to be used (postgres).
Related Name
streams.messaging.manager.storage.connector.type
Default Value
mysql
API Name
smm_database_type
Required
true

Streams Messaging Manager Database User

Description
User for Streams Messaging Manager database.
Related Name
streams.messaging.manager.storage.connector.user
Default Value
streamsmsgmgr
API Name
smm_database_user
Required
true

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

Streams Messaging Manager Rest Admin Server Role Health Test

Description
When computing the overall STREAMS_MESSAGING_MANAGER health, consider Streams Messaging Manager Rest Admin Server's health
Related Name
Default Value
true
API Name
STREAMS_MESSAGING_MANAGER_STREAMS_MESSAGING_MANAGER_SERVER_health_enabled
Required
false

Streams Messaging Manager UI Server Role Health Test

Description
When computing the overall STREAMS_MESSAGING_MANAGER health, consider Streams Messaging Manager UI Server's health
Related Name
Default Value
true
API Name
STREAMS_MESSAGING_MANAGER_STREAMS_MESSAGING_MANAGER_UI_health_enabled
Required
false

Other

Kafka Service

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

Enable Kerberos Authentication

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

Sentry Service

Description
Name of the Sentry service that this Streams Messaging Manager service instance depends on
Related Name
Default Value
API Name
sentry_service
Required
false

Streams Messaging Manager Port

Description
The port on which server accepts connections.
Related Name
streams.messaging.manager.port
Default Value
8585
API Name
streams.messaging.manager.port
Required
true

Streams Messaging Manager port (SSL)

Description
HTTPS port Streams Messaging Manager rest server runs on when SSL is enabled.
Related Name
streams.messaging.manager.ssl.port
Default Value
8587
API Name
streams.messaging.manager.ssl.port
Required
false

ZooKeeper Service

Description
Name of the ZooKeeper service that this Streams Messaging Manager service instance depends on
Related Name
Default Value
API Name
zookeeper_service
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 Configuration Validator: Cloudera Manager Service Monitor Port

Description
Whether to suppress configuration warnings produced by the Cloudera Manager Service Monitor Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_cm.metrics.service.monitor.port
Required
true

Suppress Configuration Validator: Cloudera Manager Metrics TrustStore Type

Description
Whether to suppress configuration warnings produced by the Cloudera Manager Metrics TrustStore Type configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_cm.metrics.truststore.type
Required
true

Suppress Configuration Validator: Streams Messaging Manager UI Server Advanced Configuration Snippet (Safety Valve) for config.json

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Server Advanced Configuration Snippet (Safety Valve) for config.json configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_config.json_role_safety_valve
Required
true

Suppress Configuration Validator: consumer.group.refresh.interval.ms

Description
Whether to suppress configuration warnings produced by the consumer.group.refresh.interval.ms configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_consumer.group.refresh.interval.ms
Required
true

Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for env.sh

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for env.sh configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_env.sh_role_safety_valve
Required
true

Suppress Configuration Validator: Inactive Group Timeout

Description
Whether to suppress configuration warnings produced by the Inactive Group Timeout configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_inactive.group.timeout.ms
Required
true

Suppress Configuration Validator: inactive.producer.timeout.ms

Description
Whether to suppress configuration warnings produced by the inactive.producer.timeout.ms configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_inactive.producer.timeout.ms
Required
true

Suppress Configuration Validator: LatencyMetricsConfig Metrics 15m Ttl Secs

Description
Whether to suppress configuration warnings produced by the LatencyMetricsConfig Metrics 15m Ttl Secs configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_latencymetricsconfig.metrics.15m.ttl.secs
Required
true

Suppress Configuration Validator: LatencyMetricsConfig Metrics Clean Frequency ms

Description
Whether to suppress configuration warnings produced by the LatencyMetricsConfig Metrics Clean Frequency ms configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_latencymetricsconfig.metrics.clean.frequency.ms
Required
true

Suppress Configuration Validator: Latency Metrics Data Storage Path

Description
Whether to suppress configuration warnings produced by the Latency Metrics Data Storage Path configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_latencymetricsconfig.metrics.storage
Required
true

Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server Log Directory

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server Log Directory configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_log_dir
Required
true

Suppress Configuration Validator: Metrics Cache Refresh Interval ms

Description
Whether to suppress configuration warnings produced by the Metrics Cache Refresh Interval ms configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_metrics.cache.refresh.interval.ms
Required
true

Suppress Configuration Validator: Metrics Fetcher Class

Description
Whether to suppress configuration warnings produced by the Metrics Fetcher Class configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_metrics.fetcher.class
Required
true

Suppress Configuration Validator: Number of Metrics Fetcher Threads

Description
Whether to suppress configuration warnings produced by the Number of Metrics Fetcher Threads configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_metrics.fetcher.threads
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: Java Heap Size of SMM

Description
Whether to suppress configuration warnings produced by the Java Heap Size of SMM configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_smm_heap_size
Required
true

Suppress Configuration Validator: SMM_JMX_OPTS

Description
Whether to suppress configuration warnings produced by the SMM_JMX_OPTS configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_smm_jmx_opts
Required
true

Suppress Configuration Validator: SMM_JVM_PERF_OPTS

Description
Whether to suppress configuration warnings produced by the SMM_JVM_PERF_OPTS configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_smm_jvm_perf_opts
Required
true

Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server TLS/SSL Trust Store File

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server 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: Streams Messaging Manager Rest Admin Server TLS/SSL Trust Store Password

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server 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: Streams Messaging Manager UI Server TLS/SSL Server CA Certificate (PEM Format)

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Server TLS/SSL Server CA Certificate (PEM Format) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_ca_certificate_location
Required
true

Suppress Configuration Validator: Streams Messaging Manager UI Server TLS/SSL Server Certificate File (PEM Format)

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Server TLS/SSL Server Certificate File (PEM Format) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_certificate_location
Required
true

Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore Key Password

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore Key Password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_keypassword
Required
true

Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore File Location

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore File Location configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_location
Required
true

Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore File Password

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore File Password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_password
Required
true

Suppress Configuration Validator: Streams Messaging Manager UI Server TLS/SSL Server Private Key File (PEM Format)

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Server TLS/SSL Server Private Key File (PEM Format) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_privatekey_location
Required
true

Suppress Configuration Validator: Streams Messaging Manager UI Server TLS/SSL Private Key Password

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Server TLS/SSL Private Key Password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_privatekey_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 Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for streams-messaging-manager.yaml

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for streams-messaging-manager.yaml configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams-messaging-manager.yaml_role_safety_valve
Required
true

Suppress Configuration Validator: Streams Messaging Manager Admin Port

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager Admin Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.adminport
Required
true

Suppress Configuration Validator: Allow All Alert Notifications

Description
Whether to suppress configuration warnings produced by the Allow All Alert Notifications configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.allow.all.alert.notifications
Required
true

Suppress Configuration Validator: Allowed resources

Description
Whether to suppress configuration warnings produced by the Allowed resources configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.allowed.resources
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.messaging.manager.jdk.home
Required
true

Suppress Configuration Validator: Kafka Alert Notification Topic

Description
Whether to suppress configuration warnings produced by the Kafka Alert Notification Topic configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.kafka.alert.notifications.topic
Required
true

Suppress Configuration Validator: Kafka Cache Refresh Interval ms

Description
Whether to suppress configuration warnings produced by the Kafka Cache Refresh Interval ms configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.kafka.cache.refresh.interval.ms
Required
true

Suppress Configuration Validator: Kerberos Name Rules

Description
Whether to suppress configuration warnings produced by the Kerberos Name Rules configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.kerberos.name.rules
Required
true

Suppress Configuration Validator: Kerberos Non Browser User Agents

Description
Whether to suppress configuration warnings produced by the Kerberos Non Browser User Agents configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.kerberos.non.browser.user.agents
Required
true

Suppress Configuration Validator: Streams Messaging Manager Log Max Backup Index

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager Log Max Backup Index configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.log.maxbackupindex
Required
true

Suppress Configuration Validator: Streams Messaging Manager Log Max File Size

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager Log Max File Size configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.log.maxfilesize
Required
true

Suppress Configuration Validator: Streams Messaging Manager NotifierProviders Config Classes

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager NotifierProviders Config Classes configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.providerclasses
Required
true

Suppress Configuration Validator: Save Notification Read Status Per User

Description
Whether to suppress configuration warnings produced by the Save Notification Read Status Per User configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.save.notification.read.status.per.user
Required
true

Suppress Configuration Validator: Schema Registry API url

Description
Whether to suppress configuration warnings produced by the Schema Registry API url configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.schema.registry.url
Required
true

Suppress Configuration Validator: Servlet filter

Description
Whether to suppress configuration warnings produced by the Servlet filter configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.servlet.filter
Required
true

Suppress Configuration Validator: Streams Messaging Manager Admin Port (SSL)

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager Admin Port (SSL) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.ssl.adminport
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.messaging.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.messaging.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.messaging.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.messaging.manager.ssl.validatepeers
Required
true

Suppress Configuration Validator: Streams Messaging Manager UI Port

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.ui.port
Required
true

Suppress Configuration Validator: Streams Messaging Manager Configuration Directory

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager Configuration Directory configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.working.directory
Required
true

Suppress Configuration Validator: Streams Replication Manager Rest Host

Description
Whether to suppress configuration warnings produced by the Streams Replication Manager Rest Host configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.host
Required
true

Suppress Configuration Validator: Streams Replication Manager Rest Port

Description
Whether to suppress configuration warnings produced by the Streams Replication Manager Rest Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.port
Required
true

Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams_messaging_manager_server_role_env_safety_valve
Required
true

Suppress Configuration Validator: Streams Messaging Manager UI Server Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_streams_messaging_manager_ui_role_env_safety_valve
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: Streams Messaging Manager Database Host

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Database Host parameter.
Related Name
Default Value
false
API Name
service_config_suppression_smm_database_host
Required
true

Suppress Parameter Validation: Streams Messaging Manager Database Name

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Database Name parameter.
Related Name
Default Value
false
API Name
service_config_suppression_smm_database_name
Required
true

Suppress Parameter Validation: Streams Messaging Manager Database User Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Database User Password parameter.
Related Name
Default Value
false
API Name
service_config_suppression_smm_database_password
Required
true

Suppress Parameter Validation: Streams Messaging Manager Database Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Database Port parameter.
Related Name
Default Value
false
API Name
service_config_suppression_smm_database_port
Required
true

Suppress Parameter Validation: Streams Messaging Manager Database User

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Database User parameter.
Related Name
Default Value
false
API Name
service_config_suppression_smm_database_user
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 Messaging Manager Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Port parameter.
Related Name
Default Value
false
API Name
service_config_suppression_streams.messaging.manager.port
Required
true

Suppress Parameter Validation: Streams Messaging Manager port (SSL)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager port (SSL) parameter.
Related Name
Default Value
false
API Name
service_config_suppression_streams.messaging.manager.ssl.port
Required
true

Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server Count Validator

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server Count Validator configuration validator.
Related Name
Default Value
false
API Name
service_config_suppression_streams_messaging_manager_server_count_validator
Required
true

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

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

Suppress Configuration Validator: Streams Messaging Manager UI Server Count Validator

Description
Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Server Count Validator configuration validator.
Related Name
Default Value
false
API Name
service_config_suppression_streams_messaging_manager_ui_count_validator
Required
true

Suppress Health Test: Streams Messaging Manager Rest Admin Server Health

Description
Whether to suppress the results of the Streams Messaging Manager Rest Admin Server 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_messaging_manager_streams_messaging_manager_streams_messaging_manager_server_health
Required
true

Suppress Health Test: Streams Messaging Manager UI Server Health

Description
Whether to suppress the results of the Streams Messaging Manager UI Server 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_messaging_manager_streams_messaging_manager_streams_messaging_manager_ui_health
Required
true

Streams Messaging Manager Rest Admin Server

Advanced

Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for env.sh

Description
For advanced use only. A string to be inserted into env.sh for this role only.
Related Name
Default Value
API Name
env.sh_role_safety_valve
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 heap dump file when java.lang.OutOfMemoryError is thrown.
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

Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for streams-messaging-manager.yaml

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

Streams Messaging Manager Rest Admin Server 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_MESSAGING_MANAGER_SERVER_role_env_safety_valve
Required
false

Logs

Streams Messaging Manager Rest Admin Server Log Directory

Description
The log directory for log files of the role Streams Messaging Manager Rest Admin Server.
Related Name
log_dir
Default Value
/var/log/streams-messaging-manager
API Name
log_dir
Required
false

Monitoring

Enable Health Alerts for this Role

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

Enable Configuration Change Alerts

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

Log Directory Free Space Monitoring Absolute Thresholds

Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value
Warning: 10 GiB, Critical: 5 GiB
API Name
log_directory_free_space_absolute_thresholds
Required
false

Log Directory Free Space Monitoring Percentage Thresholds

Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
log_directory_free_space_percentage_thresholds
Required
false

Metric Filter

Description
Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
Related Name
Default Value
API Name
monitoring_metric_filter
Required
false

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_messaging_manager_server_fd_thresholds
Required
false

Streams Messaging Manager Rest Admin Server Host Health Test

Description
When computing the overall Streams Messaging Manager Rest Admin Server health, consider the host's health.
Related Name
Default Value
true
API Name
streams_messaging_manager_server_host_health_enabled
Required
false

Streams Messaging Manager Rest Admin Server Process Health Test

Description
Enables the health test that the Streams Messaging Manager Rest Admin Server's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
streams_messaging_manager_server_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

Cloudera Manager Service Monitor Port

Description
Port of Cloudera Manager's Service Monitor.
Related Name
cm.metrics.service.monitor.port
Default Value
9997
API Name
cm.metrics.service.monitor.port
Required
true

Cloudera Manager Metrics TrustStore Type

Description
Cloudera Manager's truststore type.
Related Name
cm.metrics.truststore.type
Default Value
jks
API Name
cm.metrics.truststore.type
Required
true

consumer.group.refresh.interval.ms

Description
Refresh interval for consumer group's consumption.
Related Name
consumer.group.refresh.interval.ms
Default Value
50000
API Name
consumer.group.refresh.interval.ms
Required
true

Graceful Shutdown Timeout

Description
The timeout in milliseconds to wait for graceful shutdown to complete.
Related Name
Default Value
30 second(s)
API Name
graceful_stop_timeout
Required
false

Inactive Group Timeout

Description
Timeout in ms for inactive group.
Related Name
inactive.group.timeout.ms
Default Value
1800000
API Name
inactive.group.timeout.ms
Required
true

inactive.producer.timeout.ms

Description
Timeout in ms for Inactive producer.
Related Name
inactive.producer.timeout.ms
Default Value
1800000
API Name
inactive.producer.timeout.ms
Required
true

Enable Latency Metrics Processing

Description
To enable Latency Metrics Processing and Servicing. SMM will launch a service which continuously processes metrics received from producers and consumers and be able to provide responses to queries.
Related Name
latencyMetricsConfig.enable.latency.metrics.processing
Default Value
true
API Name
latencyMetricsConfig.enable.latency.metrics.processing
Required
true

LatencyMetricsConfig Metrics 15m Ttl Secs

Description
Determines the default TTL (Time To Live) for 15m granularity metrics (metrics are queryable in 15m).
Related Name
latencyMetricsConfig.metrics.15m.ttl.secs
Default Value
1209600
API Name
latencyMetricsConfig.metrics.15m.ttl.secs
Required
false

LatencyMetricsConfig Metrics Clean Frequency ms

Description
Frequency with which the metrics are cleaned from the above store in ms.
Related Name
latencyMetricsConfig.metrics.clean.frequency.ms
Default Value
21600000
API Name
latencyMetricsConfig.metrics.clean.frequency.ms
Required
false

Latency Metrics Data Storage Path

Description
Path to store latency metrics data.
Related Name
latencyMetricsConfig.metrics.storage
Default Value
/var/lib/streamsmsgmgr/latencymetrics/data
API Name
latencyMetricsConfig.metrics.storage
Required
false

logging threshold for logger appenders

Description
logging threshold for logger appenders
Related Name
loggers.appenders.threshold
Default Value
TRACE
API Name
loggers.appenders.threshold
Required
false

logging level of all loggers

Description
logging level of all loggers
Related Name
logging.level
Default Value
INFO
API Name
logging.level
Required
false

Logger org.apache.kafka Logging Level

Description
Logger org.apache.kafka logging level.
Related Name
logging.org.apache.kafka.level
Default Value
INFO
API Name
logging.org.apache.kafka.level
Required
false

Logger smm.kafka.webservice.common Logging Level

Description
Logger smm.kafka.webservice.common logging level.
Related Name
logging.smm.kafka.webservice.common.level
Default Value
DEBUG
API Name
logging.smm.kafka.webservice.common.level
Required
false

Metrics Cache Refresh Interval ms

Description
Refresh interval for data collection from CM Metrics's Collector cache.
Related Name
metrics.cache.refresh.interval.ms
Default Value
50000
API Name
metrics.cache.refresh.interval.ms
Required
true

Metrics Fetcher Class

Description
SMM's kafka metrics fetcher class.
Related Name
metrics.fetcher.class
Default Value
com.hortonworks.smm.kafka.services.metric.cm.CMMetricsFetcher
API Name
metrics.fetcher.class
Required
true

Number of Metrics Fetcher Threads

Description
Number of metrics fetcher threads.
Related Name
metrics.fetcher.threads
Default Value
25
API Name
metrics.fetcher.threads
Required
true

Java Heap Size of SMM

Description
Maximum size for the SMM Java process heap memory. Passed to Java -Xmx. Measured in megabytes.
Related Name
SMM_HEAP_SIZE
Default Value
6 GiB
API Name
SMM_HEAP_SIZE
Required
false

SMM_JMX_OPTS

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

SMM_JVM_PERF_OPTS

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

Streams Messaging Manager Admin Port

Description
The admin port for the server.
Related Name
streams.messaging.manager.adminPort
Default Value
8586
API Name
streams.messaging.manager.adminPort
Required
true

AlertTopicConsumerConfig Poll Timeout ms

Description
Alert topic Consumer config poll timeout in ms.
Related Name
streams.messaging.manager.alertTopicConsumerConfig.poll.timeout.ms
Default Value
1 second(s)
API Name
streams.messaging.manager.alertTopicConsumerConfig.poll.timeout.ms
Required
false

Allow All Alert Notifications

Description
Whether to send the alert notifications periodically.
Related Name
streams.messaging.manager.allow.all.alert.notifications
Default Value
true
API Name
streams.messaging.manager.allow.all.alert.notifications
Required
false

Allowed resources

Description
Allowed resources for Streams Messaging Manager.
Related Name
streams.messaging.manager.allowed.resources
Default Value
401.html, back-default.png, favicon.ico
API Name
streams.messaging.manager.allowed.resources
Required
false

Streams Messaging Manager Executor Thread Count

Description
Alerts config executor thread count.
Related Name
streams.messaging.manager.executor.thread.count
Default Value
30
API Name
streams.messaging.manager.executor.thread.count
Required
true

Streams Messaging Manager Executor Thread Pool Size

Description
NotifierProviders executor thread pool size.
Related Name
streams.messaging.manager.executor.thread.pool.size
Default Value
16
API Name
streams.messaging.manager.executor.thread.pool.size
Required
true

Java Home Path Override

Description
Java Home Path Override for Streams Messaging Manager
Related Name
streams.messaging.manager.jdk.home
Default Value
API Name
streams.messaging.manager.jdk.home
Required
false

Kafka Alert Notification Topic

Description
Kafka alert notification topic name.
Related Name
streams.messaging.manager.kafka.alert.notifications.topic
Default Value
__smm_alert_notifications
API Name
streams.messaging.manager.kafka.alert.notifications.topic
Required
true

Kafka Cache Refresh Interval ms

Description
SMM's cache refresh interval in ms for kafka.
Related Name
streams.messaging.manager.kafka.cache.refresh.interval.ms
Default Value
60000
API Name
streams.messaging.manager.kafka.cache.refresh.interval.ms
Required
false

Kafka Client Security Protocol

Description
Protocol to be used for communicating with Kafka, INFERRED setup assumes that Kafka service is set up the same as SMM regarding kerberos and ssl.
Related Name
streams.messaging.manager.kafka.client.security.protocol
Default Value
INFERRED
API Name
streams.messaging.manager.kafka.client.security.protocol
Required
false

Streams Messaging Manager KafkaConsumerClient Poll Timeout ms

Description
SMM's Kafka Consumer Client poll timeout in ms.
Related Name
streams.messaging.manager.kafkaConsumerClient.poll.timeout.ms
Default Value
1 second(s)
API Name
streams.messaging.manager.kafkaConsumerClient.poll.timeout.ms
Required
false

Kerberos Name Rules

Description
Kerberos name rules for Streams Messaging Manager.
Related Name
streams.messaging.manager.kerberos.name.rules
Default Value
RULE:[2:$1@$0]([jt]t@.*EXAMPLE.COM)s/.*/$MAPRED_USER/ RULE:[2:$1@$0]([nd]n@.*EXAMPLE.COM)s/.*/$HDFS_USER/DEFAULT
API Name
streams.messaging.manager.kerberos.name.rules
Required
false

Kerberos Non Browser User Agents

Description
Non browser user agents if kerberos is enabled.
Related Name
streams.messaging.manager.kerberos.non.browser.user.agents
Default Value
API Name
streams.messaging.manager.kerberos.non.browser.user.agents
Required
false

Streams Messaging Manager Log Max Backup Index

Description
The number of backup files
Related Name
streams.messaging.manager.log.maxbackupindex
Default Value
20
API Name
streams.messaging.manager.log.maxbackupindex
Required
false

Streams Messaging Manager Log Max File Size

Description
The maximum size of backup file before the log is rotated
Related Name
streams.messaging.manager.log.maxfilesize
Default Value
256MB
API Name
streams.messaging.manager.log.maxfilesize
Required
false

Streams Messaging Manager NotifierProviders Config Classes

Description
NotifierProviders config classes in list format.
Related Name
streams.messaging.manager.providerClasses
Default Value
[com.hortonworks.smm.notifier.http.HttpNotifierProvider, com.hortonworks.smm.notifier.email.EmailNotifierProvider]
API Name
streams.messaging.manager.providerClasses
Required
true

Save Notification Read Status Per User

Description
Alert notification save status flag per user.
Related Name
streams.messaging.manager.save.notification.read.status.per.user
Default Value
true
API Name
streams.messaging.manager.save.notification.read.status.per.user
Required
false

Schema Registry API url

Description
Provide API URL for Schema Registry. e.g http://SR_HOST:7788/api/v1 or https://SR_HOST:7790/api/v1
Related Name
streams.messaging.manager.schema.registry.url
Default Value
API Name
streams.messaging.manager.schema.registry.url
Required
false

Servlet filter

Description
Streams Messaging Manager servlet filter class.
Related Name
streams.messaging.manager.servlet.filter
Default Value
com.hortonworks.registries.auth.server.AuthenticationFilter
API Name
streams.messaging.manager.servlet.filter
Required
true

Streams Messaging Manager Admin Port (SSL)

Description
HTTPS admin port Streams Messaging Manager rest server runs on when SSL is enabled.
Related Name
streams.messaging.manager.ssl.adminPort
Default Value
8588
API Name
streams.messaging.manager.ssl.adminPort
Required
false

SSL Keystore Type

Description
The keystore type. Required if Streams Messaging Manager rest server's SSL is enabled. e.g. PKCS12 or JKS.
Related Name
streams.messaging.manager.ssl.keyStoreType
Default Value
jks
API Name
streams.messaging.manager.ssl.keyStoreType
Required
false

SSL TrustStore Type

Description
The truststore type. Required if streams messaging manager's ssl is enabled. e.g. PKCS12 or JKS.
Related Name
streams.messaging.manager.ssl.trustStoreType
Default Value
jks
API Name
streams.messaging.manager.ssl.trustStoreType
Required
false

SSL ValidateCerts

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

SSL validatePeers

Description
Whether or not to validate TLS peer certificates.
Related Name
streams.messaging.manager.ssl.validatePeers
Default Value
false
API Name
streams.messaging.manager.ssl.validatePeers
Required
false

Streams Messaging Manager Query Timeout

Description
Streams Messaging Manager query timeout.
Related Name
streams.messaging.manager.storage.query.timeout
Default Value
30 millisecond(s)
API Name
streams.messaging.manager.storage.query.timeout
Required
true

Token validity

Description
Kerberos token validity for Streams Messaging Manager in ms.
Related Name
streams.messaging.manager.token.validity
Default Value
36000
API Name
streams.messaging.manager.token.validity
Required
false

Streams Messaging Manager Configuration Directory

Description
Directory to Streams messaging manager additional libs, jars, isos, etc.
Related Name
streams.messaging.manager.working.directory
Default Value
/var/lib/streamsmsgmgr
API Name
streams.messaging.manager.working.directory
Required
false

Configure Streams Replication Manager

Description
Configure Streams Replication Manager.
Related Name
streams.replication.manager.configure
Default Value
false
API Name
streams.replication.manager.configure
Required
false

Streams Replication Manager Rest Host

Description
Streams Replication Manager rest host.
Related Name
streams.replication.manager.host
Default Value
API Name
streams.replication.manager.host
Required
false

Streams Replication Manager Rest Port

Description
Streams Replication Manager rest port.
Related Name
streams.replication.manager.port
Default Value
6670
API Name
streams.replication.manager.port
Required
false

Streams Replication Manager Rest Protocol

Description
Streams Replication Manager rest protocol.
Related Name
streams.replication.manager.protocol
Default Value
http
API Name
streams.replication.manager.protocol
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

Streams Messaging Manager Rest Admin Server 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 Streams Messaging Manager Rest Admin Server might connect to. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead.
Related Name
streams.messaging.manager.ssl.trustStorePath
Default Value
API Name
ssl_client_truststore_location
Required
false

Streams Messaging Manager Rest Admin Server TLS/SSL Trust Store Password

Description
The password for the Streams Messaging Manager Rest Admin Server TLS/SSL Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information.
Related Name
Default Value
API Name
ssl_client_truststore_password
Required
false

Enable TLS/SSL for Streams Messaging Manager Rest Admin Server

Description
Encrypt communication between clients and Streams Messaging Manager Rest Admin Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name
ssl.enable
Default Value
false
API Name
ssl_enabled
Required
false

Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore Key Password

Description
The password that protects the private key contained in the JKS keystore used when Streams Messaging Manager Rest Admin Server is acting as a TLS/SSL server.
Related Name
Default Value
API Name
ssl_server_keystore_keypassword
Required
false

Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS 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 Streams Messaging Manager Rest Admin Server is acting as a TLS/SSL server. The keystore must be in JKS format.
Related Name
streams.messaging.manager.ssl.keyStorePath
Default Value
API Name
ssl_server_keystore_location
Required
false

Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore File Password

Description
The password for the Streams Messaging Manager Rest Admin Server JKS keystore file.
Related Name
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: Cloudera Manager Service Monitor Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Cloudera Manager Service Monitor Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_cm.metrics.service.monitor.port
Required
true

Suppress Parameter Validation: Cloudera Manager Metrics TrustStore Type

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Cloudera Manager Metrics TrustStore Type parameter.
Related Name
Default Value
false
API Name
role_config_suppression_cm.metrics.truststore.type
Required
true

Suppress Parameter Validation: consumer.group.refresh.interval.ms

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the consumer.group.refresh.interval.ms parameter.
Related Name
Default Value
false
API Name
role_config_suppression_consumer.group.refresh.interval.ms
Required
true

Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for env.sh

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for env.sh parameter.
Related Name
Default Value
false
API Name
role_config_suppression_env.sh_role_safety_valve
Required
true

Suppress Parameter Validation: Inactive Group Timeout

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Inactive Group Timeout parameter.
Related Name
Default Value
false
API Name
role_config_suppression_inactive.group.timeout.ms
Required
true

Suppress Parameter Validation: inactive.producer.timeout.ms

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the inactive.producer.timeout.ms parameter.
Related Name
Default Value
false
API Name
role_config_suppression_inactive.producer.timeout.ms
Required
true

Suppress Parameter Validation: LatencyMetricsConfig Metrics 15m Ttl Secs

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LatencyMetricsConfig Metrics 15m Ttl Secs parameter.
Related Name
Default Value
false
API Name
role_config_suppression_latencymetricsconfig.metrics.15m.ttl.secs
Required
true

Suppress Parameter Validation: LatencyMetricsConfig Metrics Clean Frequency ms

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LatencyMetricsConfig Metrics Clean Frequency ms parameter.
Related Name
Default Value
false
API Name
role_config_suppression_latencymetricsconfig.metrics.clean.frequency.ms
Required
true

Suppress Parameter Validation: Latency Metrics Data Storage Path

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Latency Metrics Data Storage Path parameter.
Related Name
Default Value
false
API Name
role_config_suppression_latencymetricsconfig.metrics.storage
Required
true

Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server Log Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Rest Admin Server Log Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_log_dir
Required
true

Suppress Parameter Validation: Metrics Cache Refresh Interval ms

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Metrics Cache Refresh Interval ms parameter.
Related Name
Default Value
false
API Name
role_config_suppression_metrics.cache.refresh.interval.ms
Required
true

Suppress Parameter Validation: Metrics Fetcher Class

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Metrics Fetcher Class parameter.
Related Name
Default Value
false
API Name
role_config_suppression_metrics.fetcher.class
Required
true

Suppress Parameter Validation: Number of Metrics Fetcher Threads

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Number of Metrics Fetcher Threads parameter.
Related Name
Default Value
false
API Name
role_config_suppression_metrics.fetcher.threads
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: Java Heap Size of SMM

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of SMM parameter.
Related Name
Default Value
false
API Name
role_config_suppression_smm_heap_size
Required
true

Suppress Parameter Validation: SMM_JMX_OPTS

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

Suppress Parameter Validation: SMM_JVM_PERF_OPTS

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

Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server TLS/SSL Trust Store File

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Rest Admin Server 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: Streams Messaging Manager Rest Admin Server TLS/SSL Trust Store Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Rest Admin Server 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: Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore Key Password

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

Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore File Location

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

Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore File Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS 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 Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for streams-messaging-manager.yaml

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for streams-messaging-manager.yaml parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams-messaging-manager.yaml_role_safety_valve
Required
true

Suppress Parameter Validation: Streams Messaging Manager Admin Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Admin Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.adminport
Required
true

Suppress Parameter Validation: Allow All Alert Notifications

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Allow All Alert Notifications parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.allow.all.alert.notifications
Required
true

Suppress Parameter Validation: Allowed resources

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Allowed resources parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.allowed.resources
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.messaging.manager.jdk.home
Required
true

Suppress Parameter Validation: Kafka Alert Notification Topic

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Alert Notification Topic parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.kafka.alert.notifications.topic
Required
true

Suppress Parameter Validation: Kafka Cache Refresh Interval ms

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Cache Refresh Interval ms parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.kafka.cache.refresh.interval.ms
Required
true

Suppress Parameter Validation: Kerberos Name Rules

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Name Rules parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.kerberos.name.rules
Required
true

Suppress Parameter Validation: Kerberos Non Browser User Agents

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Non Browser User Agents parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.kerberos.non.browser.user.agents
Required
true

Suppress Parameter Validation: Streams Messaging Manager Log Max Backup Index

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Log Max Backup Index parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.log.maxbackupindex
Required
true

Suppress Parameter Validation: Streams Messaging Manager Log Max File Size

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Log Max File Size parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.log.maxfilesize
Required
true

Suppress Parameter Validation: Streams Messaging Manager NotifierProviders Config Classes

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager NotifierProviders Config Classes parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.providerclasses
Required
true

Suppress Parameter Validation: Save Notification Read Status Per User

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Save Notification Read Status Per User parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.save.notification.read.status.per.user
Required
true

Suppress Parameter Validation: Schema Registry API url

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Schema Registry API url parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.schema.registry.url
Required
true

Suppress Parameter Validation: Servlet filter

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Servlet filter parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.servlet.filter
Required
true

Suppress Parameter Validation: Streams Messaging Manager Admin Port (SSL)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Admin Port (SSL) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.ssl.adminport
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.messaging.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.messaging.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.messaging.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.messaging.manager.ssl.validatepeers
Required
true

Suppress Parameter Validation: Streams Messaging Manager Configuration Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Configuration Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.working.directory
Required
true

Suppress Parameter Validation: Streams Replication Manager Rest Host

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Replication Manager Rest Host parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.replication.manager.host
Required
true

Suppress Parameter Validation: Streams Replication Manager Rest Port

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

Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Rest Admin Server Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams_messaging_manager_server_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_messaging_manager_streams_messaging_manager_server_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_messaging_manager_streams_messaging_manager_server_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_messaging_manager_streams_messaging_manager_server_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_messaging_manager_streams_messaging_manager_server_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_messaging_manager_streams_messaging_manager_server_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_messaging_manager_streams_messaging_manager_server_swap_memory_usage
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_messaging_manager_streams_messaging_manager_server_unexpected_exits
Required
true

Streams Messaging Manager UI Server

Advanced

Streams Messaging Manager UI Server Advanced Configuration Snippet (Safety Valve) for config.json

Description
For advanced use only. A string to be inserted into config.json for this role only.
Related Name
Default Value
API Name
config.json_role_safety_valve
Required
false

Automatically Restart Process

Description
When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
Related Name
Default Value
false
API Name
process_auto_restart
Required
true

Enable Metric Collection

Description
Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process.
Related Name
Default Value
true
API Name
process_should_monitor
Required
true

Process Start Retry Attempts

Description
Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period.
Related Name
Default Value
3
API Name
process_start_retries
Required
false

Process Start Wait Timeout

Description
The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature.
Related Name
Default Value
20
API Name
process_start_secs
Required
false

Streams Messaging Manager UI Server 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_MESSAGING_MANAGER_UI_role_env_safety_valve
Required
false

Logs

Streams Messaging Manager UI Server Log Directory

Description
The log directory for log files of the role Streams Messaging Manager UI Server.
Related Name
log_dir
Default Value
/var/log/streams-messaging-manager
API Name
log_dir
Required
false

Monitoring

Enable Health Alerts for this Role

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

Enable Configuration Change Alerts

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

Log Directory Free Space Monitoring Absolute Thresholds

Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value
Warning: 10 GiB, Critical: 5 GiB
API Name
log_directory_free_space_absolute_thresholds
Required
false

Log Directory Free Space Monitoring Percentage Thresholds

Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
log_directory_free_space_percentage_thresholds
Required
false

Metric Filter

Description
Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
Related Name
Default Value
API Name
monitoring_metric_filter
Required
false

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_messaging_manager_ui_fd_thresholds
Required
false

Streams Messaging Manager UI Server Host Health Test

Description
When computing the overall Streams Messaging Manager UI Server health, consider the host's health.
Related Name
Default Value
true
API Name
streams_messaging_manager_ui_host_health_enabled
Required
false

Streams Messaging Manager UI Server Process Health Test

Description
Enables the health test that the Streams Messaging Manager UI Server's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
streams_messaging_manager_ui_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

Graceful Shutdown Timeout

Description
The timeout in milliseconds to wait for graceful shutdown to complete.
Related Name
Default Value
30 second(s)
API Name
graceful_stop_timeout
Required
false

Streams Messaging Manager UI Port

Description
The port on which server accepts connections.
Related Name
streams.messaging.manager.ui.port
Default Value
9991
API Name
streams.messaging.manager.ui.port
Required
true

Performance

Maximum Process File Descriptors

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

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

Streams Messaging Manager UI Server TLS/SSL Certificate Trust Store File

Description
The location on disk of the trust store, in .pem format, used to confirm the authenticity of TLS/SSL servers that Streams Messaging Manager UI Server might connect to. This is used when Streams Messaging Manager UI Server is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead.
Related Name
streams.messaging.manager.ui.ssl.trust.store.location
Default Value
API Name
ssl_client_truststore_location
Required
false

Enable TLS/SSL for Streams Messaging Manager UI Server

Description
Encrypt communication between clients and Streams Messaging Manager UI Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name
streams.messaging.manager.ui.ssl.enable
Default Value
false
API Name
ssl_enabled
Required
false

Streams Messaging Manager UI Server TLS/SSL Server CA Certificate (PEM Format)

Description
The path to the TLS/SSL file containing the certificate of the certificate authority (CA) and any intermediate certificates used to sign the server certificate. Used when Streams Messaging Manager UI Server is acting as a TLS/SSL server. The certificate file must be in PEM format, and is usually created by concatenating all of the appropriate root and intermediate certificates.
Related Name
streams.messaging.manager.ui.ssl.ca.cert.location
Default Value
API Name
ssl_server_ca_certificate_location
Required
false

Streams Messaging Manager UI Server TLS/SSL Server Certificate File (PEM Format)

Description
The path to the TLS/SSL file containing the server certificate key used for TLS/SSL. Used when Streams Messaging Manager UI Server is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name
streams.messaging.manager.ui.ssl.cert.location
Default Value
API Name
ssl_server_certificate_location
Required
false

Streams Messaging Manager UI Server TLS/SSL Server Private Key File (PEM Format)

Description
The path to the TLS/SSL file containing the private key used for TLS/SSL. Used when Streams Messaging Manager UI Server is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name
streams.messaging.manager.ui.ssl.private.key.location
Default Value
API Name
ssl_server_privatekey_location
Required
false

Streams Messaging Manager UI Server TLS/SSL Private Key Password

Description
The password for the private key in the Streams Messaging Manager UI Server TLS/SSL Server Certificate and Private Key file. If left blank, the private key is not protected by a password.
Related Name
Default Value
API Name
ssl_server_privatekey_password
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: Streams Messaging Manager UI Server Advanced Configuration Snippet (Safety Valve) for config.json

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager UI Server Advanced Configuration Snippet (Safety Valve) for config.json parameter.
Related Name
Default Value
false
API Name
role_config_suppression_config.json_role_safety_valve
Required
true

Suppress Parameter Validation: Streams Messaging Manager UI Server Log Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager UI Server Log Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_log_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: Streams Messaging Manager UI Server TLS/SSL Certificate Trust Store File

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager UI Server TLS/SSL Certificate Trust Store File parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_location
Required
true

Suppress Parameter Validation: Streams Messaging Manager UI Server TLS/SSL Server CA Certificate (PEM Format)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager UI Server TLS/SSL Server CA Certificate (PEM Format) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_ca_certificate_location
Required
true

Suppress Parameter Validation: Streams Messaging Manager UI Server TLS/SSL Server Certificate File (PEM Format)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager UI Server TLS/SSL Server Certificate File (PEM Format) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_certificate_location
Required
true

Suppress Parameter Validation: Streams Messaging Manager UI Server TLS/SSL Server Private Key File (PEM Format)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager UI Server TLS/SSL Server Private Key File (PEM Format) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_privatekey_location
Required
true

Suppress Parameter Validation: Streams Messaging Manager UI Server TLS/SSL Private Key Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager UI Server TLS/SSL Private Key Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_privatekey_password
Required
true

Suppress Parameter Validation: Streams Messaging Manager UI Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager UI Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams.messaging.manager.ui.port
Required
true

Suppress Parameter Validation: Streams Messaging Manager UI Server Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager UI Server Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_streams_messaging_manager_ui_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_messaging_manager_streams_messaging_manager_ui_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_messaging_manager_streams_messaging_manager_ui_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_messaging_manager_streams_messaging_manager_ui_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_messaging_manager_streams_messaging_manager_ui_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_messaging_manager_streams_messaging_manager_ui_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_messaging_manager_streams_messaging_manager_ui_swap_memory_usage
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_messaging_manager_streams_messaging_manager_ui_unexpected_exits
Required
true