Cloudera Docs

Streams Messaging Manager Properties in Cloudera Runtime 7.2.1

Role groups:

Service-Wide

Categories:

Advanced

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

Database

Display Name Description Related Name Default Value API Name Required
Streams Messaging Manager Database Host Hostname of the database used by Streams Messaging Manager. If the port is non-default for your database type, use host:port notation. streams.messaging.manager.storage.connector.host localhost smm_database_host true
Streams Messaging Manager Database Name Name of Streams Messaging Manager database. streams.messaging.manager.storage.connector.name streamsmsgmgr smm_database_name true
Streams Messaging Manager Database User Password Password for Streams Messaging Manager database. streams.messaging.manager.storage.connector.password smm_database_password true
Streams Messaging Manager Database Port Port for Streams Messaging Manager database. streams.messaging.manager.storage.connector.port 3306 smm_database_port true
Streams Messaging Manager Database Type Database type to be used (postgres). streams.messaging.manager.storage.connector.type mysql smm_database_type true
Streams Messaging Manager Database User User for Streams Messaging Manager database. streams.messaging.manager.storage.connector.user streamsmsgmgr smm_database_user true

Monitoring

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

Other

Display Name Description Related Name Default Value API Name Required
Enable Kerberos Authentication with Trusted Proxy Enables knox as Trusted proxy with Kerberos authentication for this SMM service. enable.trusted.proxy true enable.trusted.proxy false
Kafka Service Name of the Kafka service that this Streams Messaging Manager service instance depends on kafka_service true
Enable Kerberos Authentication Enables Kerberos authentication for this Streams Messaging Manager. kerberos.auth.enable false kerberos.auth.enable false
Ranger Plugin Trusted Proxy IP Address Accepts a list of IP addresses of proxy servers for trusting. ranger.plugin.kafka.trusted.proxy.ipaddress ranger_plugin_trusted_proxy_ipaddress false
Ranger Plugin Use X-Forwarded For IP Address The parameter is used for identifying the originating IP address of a user connecting to a component through proxy for audit logs. ranger.plugin.kafka.use.x-forwarded-for.ipaddress false ranger_plugin_use_x_forwarded_for_ipaddress false
Ranger Service Name of the Ranger service that this Streams Messaging Manager service instance depends on ranger_service false
Ranger SMM Plugin Conf Path Staging directory for Ranger SMM Plugin Configuration. This should generally not be changed. ranger_smm_plugin_conf_path $CONF_DIR/smm-plugin ranger_smm_plugin_conf_path true
Ranger Streams Messaging Manager Plugin Audit Hdfs Spool Directory Path Spool directory for Ranger audits being written to DFS. xasecure.audit.destination.hdfs.batch.filespool.dir /var/log/streams-messaging-manager/audit/hdfs/spool ranger_smm_plugin_hdfs_audit_spool_directory true
Ranger Streams Messaging Manager Plugin Policy Cache Directory Path The directory where Ranger security policies are cached locally. ranger.plugin.smm.policy.cache.dir /var/lib/ranger/kafka/policy-cache ranger_smm_plugin_policy_cache_directory true
Ranger Streams Messaging Manager Plugin Audit Solr Spool Directory Path Spool directory for Ranger audits being written to Solr. xasecure.audit.destination.solr.batch.filespool.dir /var/log/streams-messaging-manager/audit/solr/spool ranger_smm_plugin_solr_audit_spool_directory true
Schema Registry Service Name of the Schema Registry service that this Streams Messaging Manager service instance depends on schemaregistry_service false
Streams Messaging Manager Port The port on which server accepts connections. streams.messaging.manager.port 8585 streams.messaging.manager.port true
Streams Messaging Manager port (SSL) HTTPS port Streams Messaging Manager rest server runs on when SSL is enabled. streams.messaging.manager.ssl.port 8587 streams.messaging.manager.ssl.port false
ZooKeeper Service Name of the ZooKeeper service that this Streams Messaging Manager service instance depends on zookeeper_service false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Configuration Validator: Cloudera Manager Service Monitor Host Whether to suppress configuration warnings produced by the Cloudera Manager Service Monitor Host configuration validator. false role_config_suppression_cm.metrics.service.monitor.host true
Suppress Configuration Validator: Cloudera Manager Service Monitor Port Whether to suppress configuration warnings produced by the Cloudera Manager Service Monitor Port configuration validator. false role_config_suppression_cm.metrics.service.monitor.port true
Suppress Configuration Validator: Cloudera Manager Metrics TrustStore Type Whether to suppress configuration warnings produced by the Cloudera Manager Metrics TrustStore Type configuration validator. false role_config_suppression_cm.metrics.truststore.type true
Suppress Configuration Validator: Streams Messaging Manager UI Server Advanced Configuration Snippet (Safety Valve) for config.json Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Server Advanced Configuration Snippet (Safety Valve) for config.json configuration validator. false role_config_suppression_config.json_role_safety_valve true
Suppress Configuration Validator: consumer.group.refresh.interval.ms Whether to suppress configuration warnings produced by the consumer.group.refresh.interval.ms configuration validator. false role_config_suppression_consumer.group.refresh.interval.ms true
Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for env.sh Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for env.sh configuration validator. false role_config_suppression_env.sh_role_safety_valve true
Suppress Configuration Validator: Inactive Group Timeout Whether to suppress configuration warnings produced by the Inactive Group Timeout configuration validator. false role_config_suppression_inactive.group.timeout.ms true
Suppress Configuration Validator: inactive.producer.timeout.ms Whether to suppress configuration warnings produced by the inactive.producer.timeout.ms configuration validator. false role_config_suppression_inactive.producer.timeout.ms true
Suppress Configuration Validator: Kafka Connect Host Whether to suppress configuration warnings produced by the Kafka Connect Host configuration validator. false role_config_suppression_kafka.connect.host true
Suppress Configuration Validator: Kafka Connect Plugin Sample Configuration Path Whether to suppress configuration warnings produced by the Kafka Connect Plugin Sample Configuration Path configuration validator. false role_config_suppression_kafka.connect.plugin.sample.configs.path true
Suppress Configuration Validator: Kafka Connect Port Whether to suppress configuration warnings produced by the Kafka Connect Port configuration validator. false role_config_suppression_kafka.connect.port true
Suppress Configuration Validator: LatencyMetricsConfig Metrics 15m Ttl Secs Whether to suppress configuration warnings produced by the LatencyMetricsConfig Metrics 15m Ttl Secs configuration validator. false role_config_suppression_latencymetricsconfig.metrics.15m.ttl.secs true
Suppress Configuration Validator: LatencyMetricsConfig Metrics Clean Frequency ms Whether to suppress configuration warnings produced by the LatencyMetricsConfig Metrics Clean Frequency ms configuration validator. false role_config_suppression_latencymetricsconfig.metrics.clean.frequency.ms true
Suppress Configuration Validator: Latency Metrics Data Storage Path Whether to suppress configuration warnings produced by the Latency Metrics Data Storage Path configuration validator. false role_config_suppression_latencymetricsconfig.metrics.storage true
Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server Log Directory Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server Log Directory configuration validator. false role_config_suppression_log_dir true
Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server XML Override Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server XML Override configuration validator. false role_config_suppression_logback_safety_valve true
Suppress Configuration Validator: Metrics Cache Refresh Interval ms Whether to suppress configuration warnings produced by the Metrics Cache Refresh Interval ms configuration validator. false role_config_suppression_metrics.cache.refresh.interval.ms true
Suppress Configuration Validator: Metrics Fetcher Class Whether to suppress configuration warnings produced by the Metrics Fetcher Class configuration validator. false role_config_suppression_metrics.fetcher.class true
Suppress Configuration Validator: Number of Metrics Fetcher Threads Whether to suppress configuration warnings produced by the Number of Metrics Fetcher Threads configuration validator. false role_config_suppression_metrics.fetcher.threads true
Suppress Configuration Validator: Heap Dump Directory Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator. false role_config_suppression_oom_heap_dump_dir true
Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for ranger-kafka-audit.xml Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for ranger-kafka-audit.xml configuration validator. false role_config_suppression_ranger-kafka-audit.xml_role_safety_valve true
Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for ranger-kafka-policymgr-ssl.xml Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for ranger-kafka-policymgr-ssl.xml configuration validator. false role_config_suppression_ranger-kafka-policymgr-ssl.xml_role_safety_valve true
Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for ranger-kafka-security.xml Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for ranger-kafka-security.xml configuration validator. false role_config_suppression_ranger-kafka-security.xml_role_safety_valve true
Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator. false role_config_suppression_rm_custom_resources true
Suppress Configuration Validator: Role Triggers Whether to suppress configuration warnings produced by the Role Triggers configuration validator. false role_config_suppression_role_triggers true
Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for schema-registry-client-ssl-config.yaml Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for schema-registry-client-ssl-config.yaml configuration validator. false role_config_suppression_schema-registry-client-ssl-config.yaml_role_safety_valve true
Suppress Configuration Validator: Java Heap Size of SMM Whether to suppress configuration warnings produced by the Java Heap Size of SMM configuration validator. false role_config_suppression_smm_heap_size true
Suppress Configuration Validator: SMM_JMX_OPTS Whether to suppress configuration warnings produced by the SMM_JMX_OPTS configuration validator. false role_config_suppression_smm_jmx_opts true
Suppress Configuration Validator: SMM_JVM_PERF_OPTS Whether to suppress configuration warnings produced by the SMM_JVM_PERF_OPTS configuration validator. false role_config_suppression_smm_jvm_perf_opts true
Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server TLS/SSL Client Trust Store File configuration validator. false role_config_suppression_ssl_client_truststore_location true
Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server TLS/SSL Client Trust Store Password configuration validator. false role_config_suppression_ssl_client_truststore_password true
Suppress Configuration Validator: Streams Messaging Manager UI Server TLS/SSL Server CA Certificate (PEM Format) Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Server TLS/SSL Server CA Certificate (PEM Format) configuration validator. false role_config_suppression_ssl_server_ca_certificate_location true
Suppress Configuration Validator: Streams Messaging Manager UI Server TLS/SSL Server Certificate File (PEM Format) Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Server TLS/SSL Server Certificate File (PEM Format) configuration validator. false role_config_suppression_ssl_server_certificate_location true
Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore Key Password Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore Key Password configuration validator. false role_config_suppression_ssl_server_keystore_keypassword true
Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore File Location configuration validator. false role_config_suppression_ssl_server_keystore_location true
Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore File Password configuration validator. false role_config_suppression_ssl_server_keystore_password true
Suppress Configuration Validator: Streams Messaging Manager UI Server TLS/SSL Server Private Key File (PEM Format) Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Server TLS/SSL Server Private Key File (PEM Format) configuration validator. false role_config_suppression_ssl_server_privatekey_location true
Suppress Configuration Validator: Streams Messaging Manager UI Server TLS/SSL Private Key Password Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Server TLS/SSL Private Key Password configuration validator. false role_config_suppression_ssl_server_privatekey_password true
Suppress Configuration Validator: Stacks Collection Directory Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator. false role_config_suppression_stacks_collection_directory true
Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for streams-messaging-manager.yaml 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. false role_config_suppression_streams-messaging-manager.yaml_role_safety_valve true
Suppress Configuration Validator: Streams Messaging Manager Admin Port Whether to suppress configuration warnings produced by the Streams Messaging Manager Admin Port configuration validator. false role_config_suppression_streams.messaging.manager.adminport true
Suppress Configuration Validator: Allow All Alert Notifications Whether to suppress configuration warnings produced by the Allow All Alert Notifications configuration validator. false role_config_suppression_streams.messaging.manager.allow.all.alert.notifications true
Suppress Configuration Validator: Allowed resources Whether to suppress configuration warnings produced by the Allowed resources configuration validator. false role_config_suppression_streams.messaging.manager.allowed.resources true
Suppress Configuration Validator: Oracle TLS javax.net.ssl.keyStore Whether to suppress configuration warnings produced by the Oracle TLS javax.net.ssl.keyStore configuration validator. false role_config_suppression_streams.messaging.manager.javax.net.ssl.keystore true
Suppress Configuration Validator: Oracle TLS javax.net.ssl.keyStorePassword Whether to suppress configuration warnings produced by the Oracle TLS javax.net.ssl.keyStorePassword configuration validator. false role_config_suppression_streams.messaging.manager.javax.net.ssl.keystorepassword true
Suppress Configuration Validator: Oracle TLS javax.net.ssl.keyStoreType Whether to suppress configuration warnings produced by the Oracle TLS javax.net.ssl.keyStoreType configuration validator. false role_config_suppression_streams.messaging.manager.javax.net.ssl.keystoretype true
Suppress Configuration Validator: Oracle TLS javax.net.ssl.trustStore Whether to suppress configuration warnings produced by the Oracle TLS javax.net.ssl.trustStore configuration validator. false role_config_suppression_streams.messaging.manager.javax.net.ssl.truststore true
Suppress Configuration Validator: Oracle TLS javax.net.ssl.trustStorePassword Whether to suppress configuration warnings produced by the Oracle TLS javax.net.ssl.trustStorePassword configuration validator. false role_config_suppression_streams.messaging.manager.javax.net.ssl.truststorepassword true
Suppress Configuration Validator: Oracle TLS javax.net.ssl.trustStoreType Whether to suppress configuration warnings produced by the Oracle TLS javax.net.ssl.trustStoreType configuration validator. false role_config_suppression_streams.messaging.manager.javax.net.ssl.truststoretype true
Suppress Configuration Validator: Java Home Path Override Whether to suppress configuration warnings produced by the Java Home Path Override configuration validator. false role_config_suppression_streams.messaging.manager.jdk.home true
Suppress Configuration Validator: Kafka Alert Notification Topic Whether to suppress configuration warnings produced by the Kafka Alert Notification Topic configuration validator. false role_config_suppression_streams.messaging.manager.kafka.alert.notifications.topic true
Suppress Configuration Validator: Kafka Cache Refresh Interval ms Whether to suppress configuration warnings produced by the Kafka Cache Refresh Interval ms configuration validator. false role_config_suppression_streams.messaging.manager.kafka.cache.refresh.interval.ms true
Suppress Configuration Validator: Kerberos Name Rules Whether to suppress configuration warnings produced by the Kerberos Name Rules configuration validator. false role_config_suppression_streams.messaging.manager.kerberos.name.rules true
Suppress Configuration Validator: Kerberos Non Browser User Agents Whether to suppress configuration warnings produced by the Kerberos Non Browser User Agents configuration validator. false role_config_suppression_streams.messaging.manager.kerberos.non.browser.user.agents true
Suppress Configuration Validator: Oracle TLS oracle.net.authentication_services Whether to suppress configuration warnings produced by the Oracle TLS oracle.net.authentication_services configuration validator. false role_config_suppression_streams.messaging.manager.oracle.net.authentication_services true
Suppress Configuration Validator: Oracle TLS oracle.net.ssl_cipher_suites Whether to suppress configuration warnings produced by the Oracle TLS oracle.net.ssl_cipher_suites configuration validator. false role_config_suppression_streams.messaging.manager.oracle.net.ssl_cipher_suites true
Suppress Configuration Validator: oracle.net.ssl_version Whether to suppress configuration warnings produced by the oracle.net.ssl_version configuration validator. false role_config_suppression_streams.messaging.manager.oracle.net.ssl_version true
Suppress Configuration Validator: Streams Messaging Manager NotifierProviders Config Classes Whether to suppress configuration warnings produced by the Streams Messaging Manager NotifierProviders Config Classes configuration validator. false role_config_suppression_streams.messaging.manager.providerclasses true
Suppress Configuration Validator: Save Notification Read Status Per User Whether to suppress configuration warnings produced by the Save Notification Read Status Per User configuration validator. false role_config_suppression_streams.messaging.manager.save.notification.read.status.per.user true
Suppress Configuration Validator: Servlet filter Whether to suppress configuration warnings produced by the Servlet filter configuration validator. false role_config_suppression_streams.messaging.manager.servlet.filter true
Suppress Configuration Validator: Streams Messaging Manager Admin Port (SSL) Whether to suppress configuration warnings produced by the Streams Messaging Manager Admin Port (SSL) configuration validator. false role_config_suppression_streams.messaging.manager.ssl.adminport true
Suppress Configuration Validator: SSL Keystore Type Whether to suppress configuration warnings produced by the SSL Keystore Type configuration validator. false role_config_suppression_streams.messaging.manager.ssl.keystoretype true
Suppress Configuration Validator: SSL TrustStore Type Whether to suppress configuration warnings produced by the SSL TrustStore Type configuration validator. false role_config_suppression_streams.messaging.manager.ssl.truststoretype true
Suppress Configuration Validator: SSL ValidateCerts Whether to suppress configuration warnings produced by the SSL ValidateCerts configuration validator. false role_config_suppression_streams.messaging.manager.ssl.validatecerts true
Suppress Configuration Validator: SSL validatePeers Whether to suppress configuration warnings produced by the SSL validatePeers configuration validator. false role_config_suppression_streams.messaging.manager.ssl.validatepeers true
Suppress Configuration Validator: Streams Messaging Manager UI Port Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Port configuration validator. false role_config_suppression_streams.messaging.manager.ui.port true
Suppress Configuration Validator: Streams Messaging Manager Configuration Directory Whether to suppress configuration warnings produced by the Streams Messaging Manager Configuration Directory configuration validator. false role_config_suppression_streams.messaging.manager.working.directory true
Suppress Configuration Validator: Streams Replication Manager Rest Host Whether to suppress configuration warnings produced by the Streams Replication Manager Rest Host configuration validator. false role_config_suppression_streams.replication.manager.host true
Suppress Configuration Validator: Streams Replication Manager Rest Port Whether to suppress configuration warnings produced by the Streams Replication Manager Rest Port configuration validator. false role_config_suppression_streams.replication.manager.port true
Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_streams_messaging_manager_server_role_env_safety_valve true
Suppress Configuration Validator: Streams Messaging Manager UI Server Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_streams_messaging_manager_ui_role_env_safety_valve true
Suppress Parameter Validation: System Group Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter. false service_config_suppression_process_groupname true
Suppress Parameter Validation: System User Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter. false service_config_suppression_process_username true
Suppress Parameter Validation: Ranger Plugin Trusted Proxy IP Address Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Plugin Trusted Proxy IP Address parameter. false service_config_suppression_ranger_plugin_trusted_proxy_ipaddress true
Suppress Parameter Validation: Ranger SMM Plugin Conf Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger SMM Plugin Conf Path parameter. false service_config_suppression_ranger_smm_plugin_conf_path true
Suppress Parameter Validation: Ranger Streams Messaging Manager Plugin Audit Hdfs Spool Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Streams Messaging Manager Plugin Audit Hdfs Spool Directory Path parameter. false service_config_suppression_ranger_smm_plugin_hdfs_audit_spool_directory true
Suppress Parameter Validation: Ranger Streams Messaging Manager Plugin Policy Cache Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Streams Messaging Manager Plugin Policy Cache Directory Path parameter. false service_config_suppression_ranger_smm_plugin_policy_cache_directory true
Suppress Parameter Validation: Ranger Streams Messaging Manager Plugin Audit Solr Spool Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Streams Messaging Manager Plugin Audit Solr Spool Directory Path parameter. false service_config_suppression_ranger_smm_plugin_solr_audit_spool_directory true
Suppress Parameter Validation: Service Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter. false service_config_suppression_service_triggers true
Suppress Parameter Validation: Streams Messaging Manager Database Host Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Database Host parameter. false service_config_suppression_smm_database_host true
Suppress Parameter Validation: Streams Messaging Manager Database Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Database Name parameter. false service_config_suppression_smm_database_name true
Suppress Parameter Validation: Streams Messaging Manager Database User Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Database User Password parameter. false service_config_suppression_smm_database_password true
Suppress Parameter Validation: Streams Messaging Manager Database Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Database Port parameter. false service_config_suppression_smm_database_port true
Suppress Parameter Validation: Streams Messaging Manager Database User Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Database User parameter. false service_config_suppression_smm_database_user true
Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter. false service_config_suppression_smon_derived_configs_safety_valve true
Suppress Parameter Validation: Streams Messaging Manager Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Port parameter. false service_config_suppression_streams.messaging.manager.port true
Suppress Parameter Validation: Streams Messaging Manager port (SSL) Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager port (SSL) parameter. false service_config_suppression_streams.messaging.manager.ssl.port true
Suppress Configuration Validator: Streams Messaging Manager Rest Admin Server Count Validator Whether to suppress configuration warnings produced by the Streams Messaging Manager Rest Admin Server Count Validator configuration validator. false service_config_suppression_streams_messaging_manager_server_count_validator true
Suppress Parameter Validation: Streams Messaging Manager Service Environment Advanced Configuration Snippet (Safety Valve) 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. false service_config_suppression_streams_messaging_manager_service_env_safety_valve true
Suppress Configuration Validator: Streams Messaging Manager UI Server Count Validator Whether to suppress configuration warnings produced by the Streams Messaging Manager UI Server Count Validator configuration validator. false service_config_suppression_streams_messaging_manager_ui_count_validator true
Suppress Health Test: Streams Messaging Manager Rest Admin Server Health 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. false service_health_suppression_streams_messaging_manager_streams_messaging_manager_streams_messaging_manager_server_health true
Suppress Health Test: Streams Messaging Manager UI Server Health 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. false service_health_suppression_streams_messaging_manager_streams_messaging_manager_streams_messaging_manager_ui_health true

Streams Messaging Manager Rest Admin Server

Categories:

Advanced

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

Logs

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

Monitoring

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

Other

Display Name Description Related Name Default Value API Name Required
Cloudera Manager Service Monitor Host Host of Cloudera Manager's Service Monitor, required when the Cloudera Manager Server and Service Monitor are not on the same host. cm.metrics.service.monitor.host cm.metrics.service.monitor.host false
Cloudera Manager Service Monitor Port Port of Cloudera Manager's Service Monitor. cm.metrics.service.monitor.port 9997 cm.metrics.service.monitor.port true
Cloudera Manager Metrics TrustStore Type Cloudera Manager's truststore type. cm.metrics.truststore.type jks cm.metrics.truststore.type true
consumer.group.refresh.interval.ms Refresh interval for consumer group's consumption. consumer.group.refresh.interval.ms 50000 consumer.group.refresh.interval.ms true
Graceful Shutdown Timeout The timeout in milliseconds to wait for graceful shutdown to complete. 30 second(s) graceful_stop_timeout false
Inactive Group Timeout Timeout in ms for inactive group. inactive.group.timeout.ms 1800000 inactive.group.timeout.ms true
inactive.producer.timeout.ms Timeout in ms for Inactive producer. inactive.producer.timeout.ms 1800000 inactive.producer.timeout.ms true
Kafka Connect Host Kafka Connect Rest Host kafka.connect.host kafka.connect.host false
Kafka Connect Plugin Sample Configuration Path Path to the directory containing Kafka Connector Plugins' sample json config files kafka.connect.plugin.sample.configs.path /etc/kafka_connect_ext/sample-configs kafka.connect.plugin.sample.configs.path false
Kafka Connect Port Kafka Connect Rest Port kafka.connect.port 38083 kafka.connect.port false
Kafka Connect Protocol Kafka Connect Rest Protocol kafka.connect.protocol http kafka.connect.protocol false
Enable Latency Metrics Processing 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. latencyMetricsConfig.enable.latency.metrics.processing true latencyMetricsConfig.enable.latency.metrics.processing true
LatencyMetricsConfig Metrics 15m Ttl Secs Determines the default TTL (Time To Live) for 15m granularity metrics (metrics are queryable in 15m). latencyMetricsConfig.metrics.15m.ttl.secs 1209600 latencyMetricsConfig.metrics.15m.ttl.secs false
LatencyMetricsConfig Metrics Clean Frequency ms Frequency with which the metrics are cleaned from the above store in ms. latencyMetricsConfig.metrics.clean.frequency.ms 21600000 latencyMetricsConfig.metrics.clean.frequency.ms false
Latency Metrics Data Storage Path Path to store latency metrics data. latencyMetricsConfig.metrics.storage /var/lib/streams_messaging_manager/latencymetrics/data latencyMetricsConfig.metrics.storage false
Logger org.apache.kafka Logging Level Logger org.apache.kafka logging level. logging.org.apache.kafka.level INFO logging.org.apache.kafka.level false
Logger smm.kafka.webservice.common Logging Level Logger smm.kafka.webservice.common logging level. logging.smm.kafka.webservice.common.level DEBUG logging.smm.kafka.webservice.common.level false
Metrics Cache Refresh Interval ms Refresh interval for data collection from CM Metrics's Collector cache. metrics.cache.refresh.interval.ms 50000 metrics.cache.refresh.interval.ms true
Metrics Fetcher Class SMM's kafka metrics fetcher class. metrics.fetcher.class com.hortonworks.smm.kafka.services.metric.cm.CMMetricsFetcher metrics.fetcher.class true
Number of Metrics Fetcher Threads Number of metrics fetcher threads. metrics.fetcher.threads 25 metrics.fetcher.threads true
Java Heap Size of SMM Maximum size for the SMM Java process heap memory. Passed to Java -Xmx. Measured in megabytes. SMM_HEAP_SIZE 6 GiB SMM_HEAP_SIZE false
SMM_JMX_OPTS Change parameters to setup jmxremote. SMM_JMX_OPTS -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false SMM_JMX_OPTS false
SMM_JVM_PERF_OPTS SMM JVM perf and gc opts. SMM_JVM_PERF_OPTS -server -XX:+UseG1GC -XX:MaxGCPauseMillis=20 -XX:InitiatingHeapOccupancyPercent=35 -XX:+ExplicitGCInvokesConcurrent -Djava.awt.headless=true SMM_JVM_PERF_OPTS false
Streams Messaging Manager Admin Port The admin port for the server. streams.messaging.manager.adminPort 8586 streams.messaging.manager.adminPort true
AlertTopicConsumerConfig Poll Timeout ms Alert topic Consumer config poll timeout in ms. streams.messaging.manager.alertTopicConsumerConfig.poll.timeout.ms 1 second(s) streams.messaging.manager.alertTopicConsumerConfig.poll.timeout.ms false
Allow All Alert Notifications Whether to send the alert notifications periodically. streams.messaging.manager.allow.all.alert.notifications true streams.messaging.manager.allow.all.alert.notifications false
Allowed resources Allowed resources for Streams Messaging Manager. streams.messaging.manager.allowed.resources 401.html, back-default.png, favicon.ico streams.messaging.manager.allowed.resources false
Enable TLS with Oracle DB Enable TLS with Oracle as DB for Schema Registry. streams.messaging.manager.enable.TLS.Oracle false streams.messaging.manager.enable.TLS.Oracle false
Streams Messaging Manager Executor Thread Count Alerts config executor thread count. streams.messaging.manager.executor.thread.count 30 streams.messaging.manager.executor.thread.count true
Streams Messaging Manager Executor Thread Pool Size NotifierProviders executor thread pool size. streams.messaging.manager.executor.thread.pool.size 16 streams.messaging.manager.executor.thread.pool.size true
Oracle TLS javax.net.ssl.keyStore Path to keystore file if enabling TLS using Oracle DB. streams.messaging.manager.javax.net.ssl.keyStore streams.messaging.manager.javax.net.ssl.keyStore false
Oracle TLS javax.net.ssl.keyStorePassword KeyStorePassword if enabling TLS using Oracle DB. streams.messaging.manager.javax.net.ssl.keyStorePassword streams.messaging.manager.javax.net.ssl.keyStorePassword false
Oracle TLS javax.net.ssl.keyStoreType keyStoreType type if enabling TLS using Oracle DB. streams.messaging.manager.javax.net.ssl.keyStoreType streams.messaging.manager.javax.net.ssl.keyStoreType false
Oracle TLS javax.net.ssl.trustStore Required Path to truststore file if enabling TLS using Oracle DB. streams.messaging.manager.javax.net.ssl.trustStore streams.messaging.manager.javax.net.ssl.trustStore false
Oracle TLS javax.net.ssl.trustStorePassword TrustStorePassword type if enabling TLS using Oracle DB. streams.messaging.manager.javax.net.ssl.trustStorePassword streams.messaging.manager.javax.net.ssl.trustStorePassword false
Oracle TLS javax.net.ssl.trustStoreType Required Truststore type if enabling TLS using Oracle DB. streams.messaging.manager.javax.net.ssl.trustStoreType streams.messaging.manager.javax.net.ssl.trustStoreType false
Java Home Path Override Java Home Path Override for Streams Messaging Manager streams.messaging.manager.jdk.home streams.messaging.manager.jdk.home false
Kafka Alert Notification Topic Kafka alert notification topic name. streams.messaging.manager.kafka.alert.notifications.topic __smm_alert_notifications streams.messaging.manager.kafka.alert.notifications.topic true
Kafka Cache Refresh Interval ms SMM's cache refresh interval in ms for kafka. streams.messaging.manager.kafka.cache.refresh.interval.ms 60000 streams.messaging.manager.kafka.cache.refresh.interval.ms false
Kafka Client Security Protocol 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. streams.messaging.manager.kafka.client.security.protocol INFERRED streams.messaging.manager.kafka.client.security.protocol false
Streams Messaging Manager KafkaConsumerClient Poll Timeout ms SMM's Kafka Consumer Client poll timeout in ms. streams.messaging.manager.kafkaConsumerClient.poll.timeout.ms 1 second(s) streams.messaging.manager.kafkaConsumerClient.poll.timeout.ms false
Kerberos Name Rules Kerberos name rules for Streams Messaging Manager. streams.messaging.manager.kerberos.name.rules RULE:[2:$1@$0]([jt]t@.*EXAMPLE.COM)s/.*/$MAPRED_USER/ RULE:[2:$1@$0]([nd]n@.*EXAMPLE.COM)s/.*/$HDFS_USER/DEFAULT streams.messaging.manager.kerberos.name.rules false
Kerberos Non Browser User Agents Non browser user agents if kerberos is enabled. streams.messaging.manager.kerberos.non.browser.user.agents streams.messaging.manager.kerberos.non.browser.user.agents false
Oracle TLS oracle.net.authentication_services oracle net authentication service if enabling TLS using Oracle DB. streams.messaging.manager.oracle.net.authentication_services streams.messaging.manager.oracle.net.authentication_services false
Oracle TLS oracle.net.ssl_cipher_suites net ssl cipher suites if enabling TLS using Oracle DB e.g. SSL_DH_DSS_WITH_DES_CBC_SHA. streams.messaging.manager.oracle.net.ssl_cipher_suites streams.messaging.manager.oracle.net.ssl_cipher_suites false
Oracle TLS oracle.net.ssl_server_dn_match ssl server domain name match if enabling TLS using Oracle DB. streams.messaging.manager.oracle.net.ssl_server_dn_match true streams.messaging.manager.oracle.net.ssl_server_dn_match false
oracle.net.ssl_version oracle net ssl version. streams.messaging.manager.oracle.net.ssl_version streams.messaging.manager.oracle.net.ssl_version false
Streams Messaging Manager NotifierProviders Config Classes NotifierProviders config classes in list format. streams.messaging.manager.providerClasses [com.hortonworks.smm.notifier.http.HttpNotifierProvider, com.hortonworks.smm.notifier.email.EmailNotifierProvider] streams.messaging.manager.providerClasses true
Save Notification Read Status Per User Alert notification save status flag per user. streams.messaging.manager.save.notification.read.status.per.user true streams.messaging.manager.save.notification.read.status.per.user false
Servlet filter Streams Messaging Manager servlet filter class. streams.messaging.manager.servlet.filter com.hortonworks.registries.auth.server.AuthenticationFilter streams.messaging.manager.servlet.filter true
Streams Messaging Manager Admin Port (SSL) HTTPS admin port Streams Messaging Manager rest server runs on when SSL is enabled. streams.messaging.manager.ssl.adminPort 8588 streams.messaging.manager.ssl.adminPort false
SSL Keystore Type The keystore type. Required if Streams Messaging Manager rest server's SSL is enabled. e.g. PKCS12 or JKS. streams.messaging.manager.ssl.keyStoreType jks streams.messaging.manager.ssl.keyStoreType false
SSL TrustStore Type The truststore type. Required if streams messaging manager's ssl is enabled. e.g. PKCS12 or JKS. streams.messaging.manager.ssl.trustStoreType jks streams.messaging.manager.ssl.trustStoreType false
SSL ValidateCerts Whether or not to validate TLS certificates before starting. If enabled, it will refuse to start with expired or otherwise invalid certificates. streams.messaging.manager.ssl.validateCerts false streams.messaging.manager.ssl.validateCerts false
SSL validatePeers Whether or not to validate TLS peer certificates. streams.messaging.manager.ssl.validatePeers false streams.messaging.manager.ssl.validatePeers false
Streams Messaging Manager Query Timeout Streams Messaging Manager query timeout. streams.messaging.manager.storage.query.timeout 30 millisecond(s) streams.messaging.manager.storage.query.timeout true
Token validity Kerberos token validity for Streams Messaging Manager in ms. streams.messaging.manager.token.validity 36000 streams.messaging.manager.token.validity false
Streams Messaging Manager Configuration Directory Directory to Streams messaging manager additional libs, jars, isos, etc. streams.messaging.manager.working.directory /var/lib/streams_messaging_manager streams.messaging.manager.working.directory false
Configure Streams Replication Manager Configure Streams Replication Manager. streams.replication.manager.configure false streams.replication.manager.configure false
Streams Replication Manager Rest Host Streams Replication Manager rest host. streams.replication.manager.host streams.replication.manager.host false
Streams Replication Manager Rest Port Streams Replication Manager rest port. streams.replication.manager.port 6670 streams.replication.manager.port false
Streams Replication Manager Rest Protocol Streams Replication Manager rest protocol. streams.replication.manager.protocol http streams.replication.manager.protocol false

Performance

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

Resource Management

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

Security

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

Stacks Collection

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

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Cloudera Manager Service Monitor Host Whether to suppress configuration warnings produced by the built-in parameter validation for the Cloudera Manager Service Monitor Host parameter. false role_config_suppression_cm.metrics.service.monitor.host true
Suppress Parameter Validation: Cloudera Manager Service Monitor Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Cloudera Manager Service Monitor Port parameter. false role_config_suppression_cm.metrics.service.monitor.port true
Suppress Parameter Validation: Cloudera Manager Metrics TrustStore Type Whether to suppress configuration warnings produced by the built-in parameter validation for the Cloudera Manager Metrics TrustStore Type parameter. false role_config_suppression_cm.metrics.truststore.type true
Suppress Parameter Validation: consumer.group.refresh.interval.ms Whether to suppress configuration warnings produced by the built-in parameter validation for the consumer.group.refresh.interval.ms parameter. false role_config_suppression_consumer.group.refresh.interval.ms true
Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for env.sh 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. false role_config_suppression_env.sh_role_safety_valve true
Suppress Parameter Validation: Inactive Group Timeout Whether to suppress configuration warnings produced by the built-in parameter validation for the Inactive Group Timeout parameter. false role_config_suppression_inactive.group.timeout.ms true
Suppress Parameter Validation: inactive.producer.timeout.ms Whether to suppress configuration warnings produced by the built-in parameter validation for the inactive.producer.timeout.ms parameter. false role_config_suppression_inactive.producer.timeout.ms true
Suppress Parameter Validation: Kafka Connect Host Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Connect Host parameter. false role_config_suppression_kafka.connect.host true
Suppress Parameter Validation: Kafka Connect Plugin Sample Configuration Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Connect Plugin Sample Configuration Path parameter. false role_config_suppression_kafka.connect.plugin.sample.configs.path true
Suppress Parameter Validation: Kafka Connect Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Connect Port parameter. false role_config_suppression_kafka.connect.port true
Suppress Parameter Validation: LatencyMetricsConfig Metrics 15m Ttl Secs Whether to suppress configuration warnings produced by the built-in parameter validation for the LatencyMetricsConfig Metrics 15m Ttl Secs parameter. false role_config_suppression_latencymetricsconfig.metrics.15m.ttl.secs true
Suppress Parameter Validation: LatencyMetricsConfig Metrics Clean Frequency ms Whether to suppress configuration warnings produced by the built-in parameter validation for the LatencyMetricsConfig Metrics Clean Frequency ms parameter. false role_config_suppression_latencymetricsconfig.metrics.clean.frequency.ms true
Suppress Parameter Validation: Latency Metrics Data Storage Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Latency Metrics Data Storage Path parameter. false role_config_suppression_latencymetricsconfig.metrics.storage true
Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Rest Admin Server Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server XML Override Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Rest Admin Server XML Override parameter. false role_config_suppression_logback_safety_valve true
Suppress Parameter Validation: Metrics Cache Refresh Interval ms Whether to suppress configuration warnings produced by the built-in parameter validation for the Metrics Cache Refresh Interval ms parameter. false role_config_suppression_metrics.cache.refresh.interval.ms true
Suppress Parameter Validation: Metrics Fetcher Class Whether to suppress configuration warnings produced by the built-in parameter validation for the Metrics Fetcher Class parameter. false role_config_suppression_metrics.fetcher.class true
Suppress Parameter Validation: Number of Metrics Fetcher Threads Whether to suppress configuration warnings produced by the built-in parameter validation for the Number of Metrics Fetcher Threads parameter. false role_config_suppression_metrics.fetcher.threads true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for ranger-kafka-audit.xml 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 ranger-kafka-audit.xml parameter. false role_config_suppression_ranger-kafka-audit.xml_role_safety_valve true
Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for ranger-kafka-policymgr-ssl.xml 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 ranger-kafka-policymgr-ssl.xml parameter. false role_config_suppression_ranger-kafka-policymgr-ssl.xml_role_safety_valve true
Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for ranger-kafka-security.xml 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 ranger-kafka-security.xml parameter. false role_config_suppression_ranger-kafka-security.xml_role_safety_valve true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for schema-registry-client-ssl-config.yaml 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 schema-registry-client-ssl-config.yaml parameter. false role_config_suppression_schema-registry-client-ssl-config.yaml_role_safety_valve true
Suppress Parameter Validation: Java Heap Size of SMM Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of SMM parameter. false role_config_suppression_smm_heap_size true
Suppress Parameter Validation: SMM_JMX_OPTS Whether to suppress configuration warnings produced by the built-in parameter validation for the SMM_JMX_OPTS parameter. false role_config_suppression_smm_jmx_opts true
Suppress Parameter Validation: SMM_JVM_PERF_OPTS Whether to suppress configuration warnings produced by the built-in parameter validation for the SMM_JVM_PERF_OPTS parameter. false role_config_suppression_smm_jvm_perf_opts true
Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Rest Admin Server TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Rest Admin Server TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore Key Password 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. false role_config_suppression_ssl_server_keystore_keypassword true
Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore File Location 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. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server TLS/SSL Server JKS Keystore File Password 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. false role_config_suppression_ssl_server_keystore_password true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server Advanced Configuration Snippet (Safety Valve) for streams-messaging-manager.yaml 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. false role_config_suppression_streams-messaging-manager.yaml_role_safety_valve true
Suppress Parameter Validation: Streams Messaging Manager Admin Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Admin Port parameter. false role_config_suppression_streams.messaging.manager.adminport true
Suppress Parameter Validation: Allow All Alert Notifications Whether to suppress configuration warnings produced by the built-in parameter validation for the Allow All Alert Notifications parameter. false role_config_suppression_streams.messaging.manager.allow.all.alert.notifications true
Suppress Parameter Validation: Allowed resources Whether to suppress configuration warnings produced by the built-in parameter validation for the Allowed resources parameter. false role_config_suppression_streams.messaging.manager.allowed.resources true
Suppress Parameter Validation: Oracle TLS javax.net.ssl.keyStore Whether to suppress configuration warnings produced by the built-in parameter validation for the Oracle TLS javax.net.ssl.keyStore parameter. false role_config_suppression_streams.messaging.manager.javax.net.ssl.keystore true
Suppress Parameter Validation: Oracle TLS javax.net.ssl.keyStorePassword Whether to suppress configuration warnings produced by the built-in parameter validation for the Oracle TLS javax.net.ssl.keyStorePassword parameter. false role_config_suppression_streams.messaging.manager.javax.net.ssl.keystorepassword true
Suppress Parameter Validation: Oracle TLS javax.net.ssl.keyStoreType Whether to suppress configuration warnings produced by the built-in parameter validation for the Oracle TLS javax.net.ssl.keyStoreType parameter. false role_config_suppression_streams.messaging.manager.javax.net.ssl.keystoretype true
Suppress Parameter Validation: Oracle TLS javax.net.ssl.trustStore Whether to suppress configuration warnings produced by the built-in parameter validation for the Oracle TLS javax.net.ssl.trustStore parameter. false role_config_suppression_streams.messaging.manager.javax.net.ssl.truststore true
Suppress Parameter Validation: Oracle TLS javax.net.ssl.trustStorePassword Whether to suppress configuration warnings produced by the built-in parameter validation for the Oracle TLS javax.net.ssl.trustStorePassword parameter. false role_config_suppression_streams.messaging.manager.javax.net.ssl.truststorepassword true
Suppress Parameter Validation: Oracle TLS javax.net.ssl.trustStoreType Whether to suppress configuration warnings produced by the built-in parameter validation for the Oracle TLS javax.net.ssl.trustStoreType parameter. false role_config_suppression_streams.messaging.manager.javax.net.ssl.truststoretype true
Suppress Parameter Validation: Java Home Path Override Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Home Path Override parameter. false role_config_suppression_streams.messaging.manager.jdk.home true
Suppress Parameter Validation: Kafka Alert Notification Topic Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Alert Notification Topic parameter. false role_config_suppression_streams.messaging.manager.kafka.alert.notifications.topic true
Suppress Parameter Validation: Kafka Cache Refresh Interval ms Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Cache Refresh Interval ms parameter. false role_config_suppression_streams.messaging.manager.kafka.cache.refresh.interval.ms true
Suppress Parameter Validation: Kerberos Name Rules Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Name Rules parameter. false role_config_suppression_streams.messaging.manager.kerberos.name.rules true
Suppress Parameter Validation: Kerberos Non Browser User Agents Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Non Browser User Agents parameter. false role_config_suppression_streams.messaging.manager.kerberos.non.browser.user.agents true
Suppress Parameter Validation: Oracle TLS oracle.net.authentication_services Whether to suppress configuration warnings produced by the built-in parameter validation for the Oracle TLS oracle.net.authentication_services parameter. false role_config_suppression_streams.messaging.manager.oracle.net.authentication_services true
Suppress Parameter Validation: Oracle TLS oracle.net.ssl_cipher_suites Whether to suppress configuration warnings produced by the built-in parameter validation for the Oracle TLS oracle.net.ssl_cipher_suites parameter. false role_config_suppression_streams.messaging.manager.oracle.net.ssl_cipher_suites true
Suppress Parameter Validation: oracle.net.ssl_version Whether to suppress configuration warnings produced by the built-in parameter validation for the oracle.net.ssl_version parameter. false role_config_suppression_streams.messaging.manager.oracle.net.ssl_version true
Suppress Parameter Validation: Streams Messaging Manager NotifierProviders Config Classes Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager NotifierProviders Config Classes parameter. false role_config_suppression_streams.messaging.manager.providerclasses true
Suppress Parameter Validation: Save Notification Read Status Per User Whether to suppress configuration warnings produced by the built-in parameter validation for the Save Notification Read Status Per User parameter. false role_config_suppression_streams.messaging.manager.save.notification.read.status.per.user true
Suppress Parameter Validation: Servlet filter Whether to suppress configuration warnings produced by the built-in parameter validation for the Servlet filter parameter. false role_config_suppression_streams.messaging.manager.servlet.filter true
Suppress Parameter Validation: Streams Messaging Manager Admin Port (SSL) Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Admin Port (SSL) parameter. false role_config_suppression_streams.messaging.manager.ssl.adminport true
Suppress Parameter Validation: SSL Keystore Type Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL Keystore Type parameter. false role_config_suppression_streams.messaging.manager.ssl.keystoretype true
Suppress Parameter Validation: SSL TrustStore Type Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL TrustStore Type parameter. false role_config_suppression_streams.messaging.manager.ssl.truststoretype true
Suppress Parameter Validation: SSL ValidateCerts Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL ValidateCerts parameter. false role_config_suppression_streams.messaging.manager.ssl.validatecerts true
Suppress Parameter Validation: SSL validatePeers Whether to suppress configuration warnings produced by the built-in parameter validation for the SSL validatePeers parameter. false role_config_suppression_streams.messaging.manager.ssl.validatepeers true
Suppress Parameter Validation: Streams Messaging Manager Configuration Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager Configuration Directory parameter. false role_config_suppression_streams.messaging.manager.working.directory true
Suppress Parameter Validation: Streams Replication Manager Rest Host Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Replication Manager Rest Host parameter. false role_config_suppression_streams.replication.manager.host true
Suppress Parameter Validation: Streams Replication Manager Rest Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Replication Manager Rest Port parameter. false role_config_suppression_streams.replication.manager.port true
Suppress Parameter Validation: Streams Messaging Manager Rest Admin Server Environment Advanced Configuration Snippet (Safety Valve) 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. false role_config_suppression_streams_messaging_manager_server_role_env_safety_valve true
Suppress Health Test: Audit Pipeline Test Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_messaging_manager_streams_messaging_manager_server_audit_health true
Suppress Health Test: File Descriptors Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_messaging_manager_streams_messaging_manager_server_file_descriptor true
Suppress Health Test: Host Health Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_messaging_manager_streams_messaging_manager_server_host_health true
Suppress Health Test: Log Directory Free Space Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_messaging_manager_streams_messaging_manager_server_log_directory_free_space true
Suppress Health Test: Process Status Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_messaging_manager_streams_messaging_manager_server_scm_health true
Suppress Health Test: Swap Memory Usage Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_messaging_manager_streams_messaging_manager_server_swap_memory_usage true
Suppress Health Test: Unexpected Exits Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_messaging_manager_streams_messaging_manager_server_unexpected_exits true

Streams Messaging Manager UI Server

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Streams Messaging Manager UI Server Advanced Configuration Snippet (Safety Valve) for config.json For advanced use only. A string to be inserted into config.json for this role only. config.json_role_safety_valve false
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. false process_auto_restart true
Enable Metric Collection Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. true process_should_monitor true
Process Start Retry Attempts Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. 3 process_start_retries false
Process Start Wait Timeout The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. 20 process_start_secs false
Streams Messaging Manager UI Server Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. STREAMS_MESSAGING_MANAGER_UI_role_env_safety_valve false

Logs

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

Monitoring

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

Other

Display Name Description Related Name Default Value API Name Required
Graceful Shutdown Timeout The timeout in milliseconds to wait for graceful shutdown to complete. 30 second(s) graceful_stop_timeout false
Streams Messaging Manager UI Port The port on which server accepts connections. streams.messaging.manager.ui.port 9991 streams.messaging.manager.ui.port true

Performance

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

Resource Management

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

Security

Display Name Description Related Name Default Value API Name Required
Streams Messaging Manager UI Server TLS/SSL Certificate Trust Store File 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. streams.messaging.manager.ui.ssl.trust.store.location ssl_client_truststore_location false
Enable TLS/SSL for Streams Messaging Manager UI Server Encrypt communication between clients and Streams Messaging Manager UI Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). streams.messaging.manager.ui.ssl.enable false ssl_enabled false
Streams Messaging Manager UI Server TLS/SSL Server CA Certificate (PEM Format) 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. streams.messaging.manager.ui.ssl.ca.cert.location ssl_server_ca_certificate_location false
Streams Messaging Manager UI Server TLS/SSL Server Certificate File (PEM Format) 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. streams.messaging.manager.ui.ssl.cert.location ssl_server_certificate_location false
Streams Messaging Manager UI Server TLS/SSL Server Private Key File (PEM Format) 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. streams.messaging.manager.ui.ssl.private.key.location ssl_server_privatekey_location false
Streams Messaging Manager UI Server TLS/SSL Private Key Password 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. ssl_server_privatekey_password false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Streams Messaging Manager UI Server Advanced Configuration Snippet (Safety Valve) for config.json 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. false role_config_suppression_config.json_role_safety_valve true
Suppress Parameter Validation: Streams Messaging Manager UI Server Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager UI Server Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: Streams Messaging Manager UI Server TLS/SSL Certificate Trust Store File 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. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Streams Messaging Manager UI Server TLS/SSL Server CA Certificate (PEM Format) 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. false role_config_suppression_ssl_server_ca_certificate_location true
Suppress Parameter Validation: Streams Messaging Manager UI Server TLS/SSL Server Certificate File (PEM Format) 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. false role_config_suppression_ssl_server_certificate_location true
Suppress Parameter Validation: Streams Messaging Manager UI Server TLS/SSL Server Private Key File (PEM Format) 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. false role_config_suppression_ssl_server_privatekey_location true
Suppress Parameter Validation: Streams Messaging Manager UI Server TLS/SSL Private Key Password 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. false role_config_suppression_ssl_server_privatekey_password true
Suppress Parameter Validation: Streams Messaging Manager UI Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Streams Messaging Manager UI Port parameter. false role_config_suppression_streams.messaging.manager.ui.port true
Suppress Parameter Validation: Streams Messaging Manager UI Server Environment Advanced Configuration Snippet (Safety Valve) 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. false role_config_suppression_streams_messaging_manager_ui_role_env_safety_valve true
Suppress Health Test: Audit Pipeline Test Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_messaging_manager_streams_messaging_manager_ui_audit_health true
Suppress Health Test: File Descriptors Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_messaging_manager_streams_messaging_manager_ui_file_descriptor true
Suppress Health Test: Host Health Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_messaging_manager_streams_messaging_manager_ui_host_health true
Suppress Health Test: Log Directory Free Space Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_messaging_manager_streams_messaging_manager_ui_log_directory_free_space true
Suppress Health Test: Process Status Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_messaging_manager_streams_messaging_manager_ui_scm_health true
Suppress Health Test: Swap Memory Usage Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_messaging_manager_streams_messaging_manager_ui_swap_memory_usage true
Suppress Health Test: Unexpected Exits Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_streams_messaging_manager_streams_messaging_manager_ui_unexpected_exits true