Kafka Properties in Cloudera Runtime 7.1.x

Role groups:

Gateway

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Deploy Directory The directory where the client configs will be deployed /etc/kafka client_config_root_dir true
Kafka Client Advanced Configuration Snippet (Safety Valve) for kafka-conf/kafka-client.conf For advanced use only, a string to be inserted into the client configuration for kafka-conf/kafka-client.conf. kafka-conf/kafka-client.conf_client_config_safety_valve false
Kafka Client Advanced Configuration Snippet (Safety Valve) for kafka-conf/kafka-cluster-configs.properties For advanced use only, a string to be inserted into the client configuration for kafka-conf/kafka-cluster-configs.properties. kafka-conf/kafka-cluster-configs.properties_client_config_safety_valve false
Kafka Client Advanced Configuration Snippet (Safety Valve) for kafka-conf/kafka-ranger-repo.properties For advanced use only, a string to be inserted into the client configuration for kafka-conf/kafka-ranger-repo.properties. kafka-conf/kafka-ranger-repo.properties_client_config_safety_valve false
Gateway Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false

Logs

Display Name Description Related Name Default Value API Name Required
Gateway Logging Threshold The minimum log level for Gateway logs INFO log_threshold false

Monitoring

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

Other

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

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Deploy Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Deploy Directory parameter. false role_config_suppression_client_config_root_dir true
Suppress Parameter Validation: Kafka Client Advanced Configuration Snippet (Safety Valve) for kafka-conf/kafka-client.conf Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Client Advanced Configuration Snippet (Safety Valve) for kafka-conf/kafka-client.conf parameter. false role_config_suppression_kafka-conf/kafka-client.conf_client_config_safety_valve true
Suppress Parameter Validation: Kafka Client Advanced Configuration Snippet (Safety Valve) for kafka-conf/kafka-cluster-configs.properties Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Client Advanced Configuration Snippet (Safety Valve) for kafka-conf/kafka-cluster-configs.properties parameter. false role_config_suppression_kafka-conf/kafka-cluster-configs.properties_client_config_safety_valve true
Suppress Parameter Validation: Kafka Client Advanced Configuration Snippet (Safety Valve) for kafka-conf/kafka-ranger-repo.properties Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Client Advanced Configuration Snippet (Safety Valve) for kafka-conf/kafka-ranger-repo.properties parameter. false role_config_suppression_kafka-conf/kafka-ranger-repo.properties_client_config_safety_valve true
Suppress Parameter Validation: Gateway Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true

Kafka Broker

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Kafka Broker Advanced Configuration Snippet (Safety Valve) for kafka-monitoring.properties For advanced use only. A string to be inserted into kafka-monitoring.properties for this role only. kafka-monitoring.properties_role_safety_valve false
Kafka Broker Advanced Configuration Snippet (Safety Valve) for kafka.properties For advanced use only. A string to be inserted into kafka.properties for this role only. kafka.properties_role_safety_valve false
Kafka Broker 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. KAFKA_BROKER_role_env_safety_valve false
Kafka Broker Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_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
Kafka Broker 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
Kafka Broker 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
Kafka Broker 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
Kafka Broker Advanced Configuration Snippet (Safety Valve) for ssl.properties For advanced use only. A string to be inserted into ssl.properties for this role only. ssl.properties_role_safety_valve false

Logs

Display Name Description Related Name Default Value API Name Required
Kafka Broker Log Directory The log directory for log files of the role Kafka Broker. kafka.log4j.dir /var/log/kafka log_dir false
Kafka Broker Logging Threshold The minimum log level for Kafka Broker logs INFO log_threshold false
Kafka Broker Maximum Log File Backups The maximum number of rolled log files to keep for Kafka Broker logs. Typically used by log4j or logback. 10 max_log_backup_index false
Kafka Broker Max Log Size The maximum size, in megabytes, per log file for Kafka Broker 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
Enable Lagging Replicas Test Enables or disables the health test. When disabled, the test does not run at all, nor generate health history. true KAFKA-KAFKA_BROKER-7.1.0-LAGGING_REPLICAS_test_enable false
Enable Offline Directory Test Enables or disables the health test. When disabled, the test does not run at all, nor generate health history. true KAFKA-KAFKA_BROKER-7.1.0-OFFLINE_DIRECTORIES_test_enable false
Enable Offline Partitions Test Enables or disables the health test. When disabled, the test does not run at all, nor generate health history. true KAFKA-KAFKA_BROKER-7.1.0-OFFLINE_PARTITIONS_test_enable false
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 % kafka_broker_fd_thresholds false
Kafka Broker Host Health Test When computing the overall Kafka Broker health, consider the host's health. true kafka_broker_host_health_enabled false
Kafka Broker Process Health Test Enables the health test that the Kafka Broker's process state is consistent with the role configuration true kafka_broker_scm_health_enabled 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
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
Advertised Host If set, this is the hostname given out to producers, consumers, and other brokers to use in establishing connections. Never set this property at the group level; it should always be overriden on instance level. advertised.host.name advertised.host.name false
Authenticate Zookeeper Connection Enables authentication of SASL connections with zookeeper, if Kerberos authentication is enabled. It also allows a broker to set SASL ACL on zookeeper nodes, which locks these nodes down so that only a Kafka broker can modify it. authenticate.zookeeper.connection true authenticate.zookeeper.connection false
Broker ID ID uniquely identifying each broker. Never set this property at the group level; it should always be overridden on instance level. broker.id broker.id false
Additional Broker Java Options These arguments are passed as part of the Java command line. Commonly, garbage collection flags or extra debugging flags are passed here. broker_java_opts -server -XX:+UseG1GC -XX:MaxGCPauseMillis=20 -XX:InitiatingHeapOccupancyPercent=35 -XX:G1HeapRegionSize=16M -XX:MinMetaspaceFreeRatio=50 -XX:MaxMetaspaceFreeRatio=80 -XX:+DisableExplicitGC -Djava.awt.headless=true -Djava.net.preferIPv4Stack=true -Dcom.sun.management.jmxremote.host=127.0.0.1 -Dcom.sun.management.jmxremote.local.only=true -Djava.rmi.server.hostname=127.0.0.1 broker_java_opts false
Java Heap Size of Broker Maximum size for the Java process heap memory. Passed to Java -Xmx. Measured in megabytes. Kafka does not generally require setting large heap sizes. It is better to let the file system cache utilize the available memory. broker_max_heap_size 1 GiB broker_max_heap_size false
Kafka Broker Diagnostics Collection Timeout The timeout in milliseconds to wait for diagnostics collection to complete. 5 minute(s) csd_role_diagnostics_timeout false
Graceful Shutdown Timeout The timeout in milliseconds to wait for graceful shutdown to complete. 2 minute(s) graceful_stop_timeout false
Enable Authenticated Communication with the JMX Agent Enables Authenticated Communication with the JMX Agent. jmx.auth.enabled false jmx.auth.enabled false
Name of User with Read-Write Access to the JMX Agent Specifies the name of the user that has read-write privileges when using password file-based authentication for JMX access. JMX authentication must be enabled for this setting to take effect. jmx.control.user controlRole jmx.control.user false
Password of user with read-write access to the JMX agent Specifies the password of the user that has read-write privileges when using password file-based authentication for JMX access. JMX authentication must be enabled for this setting to take effect. jmx.control.user.passwd jmx.control.user.passwd false
Name of User with read-only access to the JMX Agent Specifies the name of the user that has read-only privileges when using password file-based authentication for JMX access. JMX authentication must be enabled for this setting to take effect. jmx.monitor.user monitorRole jmx.monitor.user false
Password of User with read-only Access to the JMX agent Specifies the password of the user that has read-only privileges when using password file-based authentication for JMX access. JMX authentication must be enabled for this setting to take effect. jmx.monitor.user.passwd jmx.monitor.user.passwd false
Enable TLS client authentication for JMX port If enabled, a valid client certificate must be presented by the JMX client in order to connect to the JMX port. Ensure that the trusted CA certificates are present in either the Kafka JMX TLS/SSL Server Trust Store file or the global trust store. jmx.ssl.client.auth.enabled false jmx.ssl.client.auth.enabled false
Enable TLS/SSL for Kafka JMX Encrypt communication between clients and Kafka JMX using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). jmx.ssl.enabled false jmx.ssl.enabled false
HTTP Metric Report Host The host that the HTTP metric reporter binds to. kafka.http.metrics.host 0.0.0.0 kafka.http.metrics.host false
Data Directories A list of one or more directories in which Kafka data is stored.. Each new partition created is placed in the directory that currently has the least amount of partitions.. Each directory should be on its own separate drive. log.dirs /var/local/kafka/data log.dirs true
Data Retention Size The amount of data to retain in the log for each topic-partition. This is the limit per partition. Multiply it by the number of partitions to get the total amount of data retained for the topic. This property can take -1 as a value, which is interpreted as unlimited. If both log.retention.ms and log.retention.bytes are set, a segment is deleted when either limit is exceeded. log.retention.bytes -1 B log.retention.bytes false
Data Retention Check Interval The frequency, in milliseconds, that the log cleaner checks whether any log segment is eligible for deletion, per retention policies. log.retention.check.interval.ms 5 minute(s) log.retention.check.interval.ms false
Data Retention Time The maximum time before a new log segment is rolled out. If both log.retention.ms and log.retention.bytes are set, a segment is deleted when either limit is exceeded. This property can take -1 as a value, which is interpreted as unlimited. log.retention.ms 7 day(s) log.retention.ms true
Data Log Roll Time The maximum time before a new log segment is rolled out. log.roll.ms log.roll.ms false
Segment File Size The log for a topic partition is stored as a directory of segment files. This setting controls the size to which a segment file can grow before a new segment is rolled over in the log. This value has to be larger than message.max.bytes. log.segment.bytes 1 GiB log.segment.bytes false
Maximum Connections per IP Address Maximum number of connections allowed from each IP address. max.connections.per.ip max.connections.per.ip false
Number of I/O Threads The number of I/O threads that the server uses for executing requests. You should have at least as many threads as you have disks. num.io.threads 8 num.io.threads false
Number of Network Threads Number of threads that the server uses to handle incoming requests and outgoing responses. num.network.threads 8 num.network.threads false
Number of Recovery Threads per data directory Number of threads per data directory that the server uses for log recovery during startup and log flushing during shutdown. Increasing this value may improve broker startup performance if you have a high number of segments. The total number of recovery threads (number of threads per data dir * number of data dirs) should not exceed the number of CPU cores. The default value is 1. num.recovery.threads.per.data.dir 1 num.recovery.threads.per.data.dir false
Number of Alter Log Dir Threads Number of threads that the server uses to move data between log directories. The default value of this property is the same as the number of log directories. num.replica.alter.log.dirs.threads num.replica.alter.log.dirs.threads false
Ranger Kafka Plugin Conf Path Staging directory for Ranger Kafka Plugin Configuration. This should generally not be changed. ranger_kafka_plugin_conf_path /etc/ranger/kafka-plugin ranger_kafka_plugin_conf_path true
Ranger Kafka Plugin Audit Hdfs Spool Directory Path Spool directory for Ranger audits being written to DFS. xasecure.audit.destination.hdfs.batch.filespool.dir /var/log/kafka/audit/hdfs/spool ranger_kafka_plugin_hdfs_audit_spool_directory true
Ranger Kafka Plugin Policy Cache Directory Path The directory where Ranger security policies are cached locally. ranger.plugin.kafka.policy.cache.dir /var/lib/ranger/kafka/policy-cache ranger_kafka_plugin_policy_cache_directory true
Ranger Kafka Plugin Audit Solr Spool Directory Path Spool directory for Ranger audits being written to Solr. xasecure.audit.destination.solr.batch.filespool.dir /var/log/kafka/audit/solr/spool ranger_kafka_plugin_solr_audit_spool_directory true
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
Inter Broker Protocol Protocol to be used for inter-broker communication. INFERRED uses the same protocol that is configured for external clients. security.inter.broker.protocol INFERRED security.inter.broker.protocol false
Socket receive buffer size. The SO_RCVBUF buffer of the socket server sockets. If the value is -1, the OS default will be used. socket.receive.buffer.bytes 100 KiB socket.receive.buffer.bytes false
Socket receive buffer size. The maximum number of bytes in a socket request socket.request.max.bytes 100 MiB socket.request.max.bytes false
Socket send buffer size. The SO_SNDBUF buffer of the socket server sockets. If the value is -1, the OS default will be used. socket.send.buffer.bytes 100 KiB socket.send.buffer.bytes false
SSL Client Authentication Client authentication mode for SSL connections. This configuration has three valid values, "required", "requested" and "none". If set to "required", client authentication is required. If set to "requested", client authentication is requested and clients without certificates can still connect. If set to "none", which is the default value, no client authentication is required. ssl.client.auth none ssl.client.auth false
Enable Zookeeper ACL Enables brokers to set SASL ACL on zookeeper nodes if authenticate.zookeeper.connection is enabled. zookeeper.set.acl true zookeeper.set.acl 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

Ports and Addresses

Display Name Description Related Name Default Value API Name Required
Advertised Port The port to give out to producers, consumers, and other brokers to use in establishing connections. This only needs to be set if this port is different from the port the server should bind to. advertised.port advertised.port false
JMX Port Port for JMX. jmx_port 9393 jmx_port false
HTTP Metric Report Port The port that the HTTP metric reporter listens on. kafka.http.metrics.port 24042 kafka.http.metrics.port false
TCP Port Kafka broker port. port 9092 port false
TLS/SSL Port Kafka broker secure port. ssl_port 9093 ssl_port 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
Kafka Broker 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 Kafka Broker might connect to. This is used when Kafka Broker is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead. ssl.truststore.location ssl_client_truststore_location false
Kafka Broker TLS/SSL Client Trust Store Password The password for the Kafka Broker TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. ssl.truststore.password.generator ssl_client_truststore_password false
Enable TLS/SSL for Kafka Broker Encrypt communication between clients and Kafka Broker using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). ssl_enabled false ssl_enabled false
Kafka Broker TLS/SSL Server JKS Keystore Key Password The password that protects the private key contained in the JKS keystore used when Kafka Broker is acting as a TLS/SSL server. ssl.key.password.generator ssl_server_keystore_keypassword false
Kafka Broker 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 Kafka Broker is acting as a TLS/SSL server. The keystore must be in JKS format. ssl.keystore.location ssl_server_keystore_location false
Kafka Broker TLS/SSL Server JKS Keystore File Password The password for the Kafka Broker JKS keystore file. ssl.keystore.password.generator 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 Parameter Validation: Advertised Host Whether to suppress configuration warnings produced by the built-in parameter validation for the Advertised Host parameter. false role_config_suppression_advertised.host.name true
Suppress Parameter Validation: Advertised Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Advertised Port parameter. false role_config_suppression_advertised.port true
Suppress Parameter Validation: Broker ID Whether to suppress configuration warnings produced by the built-in parameter validation for the Broker ID parameter. false role_config_suppression_broker.id true
Suppress Parameter Validation: Additional Broker Java Options Whether to suppress configuration warnings produced by the built-in parameter validation for the Additional Broker Java Options parameter. false role_config_suppression_broker_java_opts true
Suppress Parameter Validation: Java Heap Size of Broker Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of Broker parameter. false role_config_suppression_broker_max_heap_size true
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: Name of User with Read-Write Access to the JMX Agent Whether to suppress configuration warnings produced by the built-in parameter validation for the Name of User with Read-Write Access to the JMX Agent parameter. false role_config_suppression_jmx.control.user true
Suppress Parameter Validation: Password of user with read-write access to the JMX agent Whether to suppress configuration warnings produced by the built-in parameter validation for the Password of user with read-write access to the JMX agent parameter. false role_config_suppression_jmx.control.user.passwd true
Suppress Parameter Validation: Name of User with read-only access to the JMX Agent Whether to suppress configuration warnings produced by the built-in parameter validation for the Name of User with read-only access to the JMX Agent parameter. false role_config_suppression_jmx.monitor.user true
Suppress Parameter Validation: Password of User with read-only Access to the JMX agent Whether to suppress configuration warnings produced by the built-in parameter validation for the Password of User with read-only Access to the JMX agent parameter. false role_config_suppression_jmx.monitor.user.passwd true
Suppress Parameter Validation: JMX Port Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Port parameter. false role_config_suppression_jmx_port true
Suppress Parameter Validation: Kafka Broker Advanced Configuration Snippet (Safety Valve) for kafka-monitoring.properties Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Broker Advanced Configuration Snippet (Safety Valve) for kafka-monitoring.properties parameter. false role_config_suppression_kafka-monitoring.properties_role_safety_valve true
Suppress Parameter Validation: HTTP Metric Report Host Whether to suppress configuration warnings produced by the built-in parameter validation for the HTTP Metric Report Host parameter. false role_config_suppression_kafka.http.metrics.host true
Suppress Parameter Validation: HTTP Metric Report Port Whether to suppress configuration warnings produced by the built-in parameter validation for the HTTP Metric Report Port parameter. false role_config_suppression_kafka.http.metrics.port true
Suppress Parameter Validation: Kafka Broker Advanced Configuration Snippet (Safety Valve) for kafka.properties Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Broker Advanced Configuration Snippet (Safety Valve) for kafka.properties parameter. false role_config_suppression_kafka.properties_role_safety_valve true
Suppress Parameter Validation: Kafka Broker Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Broker Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_kafka_broker_role_env_safety_valve true
Suppress Parameter Validation: Data Directories Whether to suppress configuration warnings produced by the built-in parameter validation for the Data Directories parameter. false role_config_suppression_log.dirs true
Suppress Parameter Validation: Segment File Size Whether to suppress configuration warnings produced by the built-in parameter validation for the Segment File Size parameter. false role_config_suppression_log.segment.bytes true
Suppress Parameter Validation: Kafka Broker Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Broker Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Kafka Broker Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Broker Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: Number of I/O Threads Whether to suppress configuration warnings produced by the built-in parameter validation for the Number of I/O Threads parameter. false role_config_suppression_num.io.threads true
Suppress Parameter Validation: Number of Network Threads Whether to suppress configuration warnings produced by the built-in parameter validation for the Number of Network Threads parameter. false role_config_suppression_num.network.threads true
Suppress Parameter Validation: Number of Recovery Threads per data directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Number of Recovery Threads per data directory parameter. false role_config_suppression_num.recovery.threads.per.data.dir true
Suppress Parameter Validation: Number of Alter Log Dir Threads Whether to suppress configuration warnings produced by the built-in parameter validation for the Number of Alter Log Dir Threads parameter. false role_config_suppression_num.replica.alter.log.dirs.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: TCP Port Whether to suppress configuration warnings produced by the built-in parameter validation for the TCP Port parameter. false role_config_suppression_port true
Suppress Parameter Validation: Kafka Broker Advanced Configuration Snippet (Safety Valve) for ranger-kafka-audit.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Broker 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: Kafka Broker 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 Kafka Broker 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: Kafka Broker Advanced Configuration Snippet (Safety Valve) for ranger-kafka-security.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Broker 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: Ranger Kafka Plugin Conf Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Kafka Plugin Conf Path parameter. false role_config_suppression_ranger_kafka_plugin_conf_path true
Suppress Parameter Validation: Ranger Kafka Plugin Audit Hdfs Spool Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Kafka Plugin Audit Hdfs Spool Directory Path parameter. false role_config_suppression_ranger_kafka_plugin_hdfs_audit_spool_directory true
Suppress Parameter Validation: Ranger Kafka Plugin Policy Cache Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Kafka Plugin Policy Cache Directory Path parameter. false role_config_suppression_ranger_kafka_plugin_policy_cache_directory true
Suppress Parameter Validation: Ranger Kafka Plugin Audit Solr Spool Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Kafka Plugin Audit Solr Spool Directory Path parameter. false role_config_suppression_ranger_kafka_plugin_solr_audit_spool_directory 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 role_config_suppression_ranger_plugin_trusted_proxy_ipaddress 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: Kafka Broker Advanced Configuration Snippet (Safety Valve) for ssl.properties Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Broker Advanced Configuration Snippet (Safety Valve) for ssl.properties parameter. false role_config_suppression_ssl.properties_role_safety_valve true
Suppress Parameter Validation: Kafka Broker TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Broker TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Kafka Broker TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Broker TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: TLS/SSL Port Whether to suppress configuration warnings produced by the built-in parameter validation for the TLS/SSL Port parameter. false role_config_suppression_ssl_port true
Suppress Parameter Validation: Kafka Broker TLS/SSL Server JKS Keystore Key Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Broker TLS/SSL Server JKS Keystore Key Password parameter. false role_config_suppression_ssl_server_keystore_keypassword true
Suppress Parameter Validation: Kafka Broker TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Broker TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Kafka Broker TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Broker 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 Health Test: Lagging Replicas Test Whether to suppress the results of the Lagging Replicas 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_kafka-kafka_broker-7.1.0-lagging_replicas true
Suppress Health Test: Offline Directory Test Whether to suppress the results of the Offline Directory 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_kafka-kafka_broker-7.1.0-offline_directories true
Suppress Health Test: Offline Partitions Test Whether to suppress the results of the Offline Partitions 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_kafka-kafka_broker-7.1.0-offline_partitions 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_kafka_kafka_broker_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_kafka_kafka_broker_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_kafka_kafka_broker_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_kafka_kafka_broker_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_kafka_kafka_broker_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_kafka_kafka_broker_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_kafka_kafka_broker_unexpected_exits true

Kafka Connect

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Kafka Connect Advanced Configuration Snippet (Safety Valve) for connect-distributed.properties For advanced use only. A string to be inserted into connect-distributed.properties for this role only. connect-distributed.properties_role_safety_valve false
Kafka Connect 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. KAFKA_CONNECT_role_env_safety_valve false
Kafka Connect Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_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

Logs

Display Name Description Related Name Default Value API Name Required
Kafka Connect Log Directory The log directory for log files of the role Kafka Connect. kafka_connect.log4j.dir /var/log/kafka log_dir false
Kafka Connect Logging Threshold The minimum log level for Kafka Connect logs INFO log_threshold false
Kafka Connect Maximum Log File Backups The maximum number of rolled log files to keep for Kafka Connect logs. Typically used by log4j or logback. 10 max_log_backup_index false
Kafka Connect Max Log Size The maximum size, in megabytes, per log file for Kafka Connect 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
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 % kafka_connect_fd_thresholds false
Kafka Connect Host Health Test When computing the overall Kafka Connect health, consider the host's health. true kafka_connect_host_health_enabled false
Kafka Connect Process Health Test Enables the health test that the Kafka Connect's process state is consistent with the role configuration true kafka_connect_scm_health_enabled 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
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
Broker List for Kafka Connect Comma-separated list of IP:port (or hostname:port) pairs of brokers on source cluster for Kafka Connect to connect. This should be more than one, for high availability. bootstrap.servers bootstrap.servers true
config.storage.replication.factor Default replication factor of Kafka Connect's config storage topic config.storage.replication.factor 1 config.storage.replication.factor true
config.storage.topic Topic to use for storing connector and task configurations; This should be a single partition, highly replicated and compacted topic. Kafka Connect will attempt to create the topic automatically when needed before starting Kafka Connect. config.storage.topic connect-configs config.storage.topic true
connect.log4j.connector.context The `%X{connector.context}` parameter in the layout includes connector-specific and task-specific information in the log message, where appropriate. This makes it easier to identify those log messages that apply to a specific connector connector.context connector.context false
group.id Unique name for the cluster, used in forming the Connect cluster group. Note that this must not conflict with consumer group IDs. group.id connect-cluster group.id true
Kafka Connect Configuration Directory Directory with all configurations for Kafka Connect daemons kafka.connect.conf.directory $CONF_DIR kafka.connect.conf.directory true
Java Home Path Override Java Home Path Override for Kafka Connect kafka.connect.jdk.home kafka.connect.jdk.home false
KAFKA_HEAP_OPTS Memory heap params while using Kafka Connect. KAFKA_HEAP_OPTS -Xms256M -Xmx2G KAFKA_HEAP_OPTS false
key.converter The converters specify the format of data in Kafka and how to translate it into Connect data. Every Connect user will need to configure these based on the format they want their data in when loaded from or stored into Kafka key.converter org.apache.kafka.connect.json.JsonConverter key.converter true
key.converter.schemas.enable Converter-specific settings can be passed in by prefixing the Converter's setting with the converter we want to apply it to key.converter.schemas.enable true key.converter.schemas.enable true
metrics.jetty.server.port Jetty Metrics port to expose JMX Json metrics.jetty.server.port 38084 metrics.jetty.server.port true
offset.flush.interval.ms Offset flush interval in ms. offset.flush.interval.ms 1 minute(s) offset.flush.interval.ms true
offset.storage.replication.factor Default replication factor of Kafka Connect's offset storage topic offset.storage.replication.factor 1 offset.storage.replication.factor true
offset.storage.topic Topic to use for storing offsets. Kafka Connect will attempt to create the topic automatically when needed, but you can always manually create before starting Kafka Connect. offset.storage.topic connect-offsets offset.storage.topic true
plugin.path Path to directories immediately containing jars with plugins and their dependencies, uber-jars with plugins and their dependencies and classes of plugins and their dependencies plugin.path /var/lib/kafka plugin.path false
rest.extension.classes JMS Json Rest Extension class rest.extension.classes com.cloudera.dim.kafka.metrics.JmxJsonMetricsRestExtension rest.extension.classes true
kafka.connect.rest.port Kafka Connect rest port rest.port 38083 rest.port true
kafka.connect.secure.rest.port Kafka Connect secure rest port secure.rest.port 38085 secure.rest.port true
SSL Client Authentication Client authentication mode for SSL connections. If set to "required", client authentication is required. If set to "requested", client authentication is requested and clients without certificates can still connect. If set to "none", which is the default value, no client authentication is required. ssl.client.auth none ssl.client.auth false
status.storage.replication.factor Default replication factor of Kafka Connect's status storage topic status.storage.replication.factor 1 status.storage.replication.factor true
status.storage.topic Topic to use for storing statuses. Kafka Connect will attempt to create the topic automatically when needed, but you can always manually create before starting Kafka Connect. status.storage.topic connect-status status.storage.topic true
value.converter The converters specify the format of data in Kafka and how to translate it into Connect data. Every Connect user will need to configure these based on the format they want their data in when loaded from or stored into Kafka value.converter org.apache.kafka.connect.json.JsonConverter value.converter true
value.converter.schemas.enable Converter-specific settings can be passed in by prefixing the Converter's setting with the converter we want to apply it to value.converter.schemas.enable true value.converter.schemas.enable 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
Kafka Connect 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 Kafka Connect might connect to. This is used when Kafka Connect is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead. ssl.truststore.location ssl_client_truststore_location false
Kafka Connect TLS/SSL Client Trust Store Password The password for the Kafka Connect TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. ssl.truststore.password.generator ssl_client_truststore_password false
Enable TLS/SSL for Kafka Connect Encrypt communication between clients and Kafka Connect using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). ssl_enabled false ssl_enabled false
Kafka Connect TLS/SSL Server JKS Keystore Key Password The password that protects the private key contained in the JKS keystore used when Kafka Connect is acting as a TLS/SSL server. ssl.key.password.generator ssl_server_keystore_keypassword false
Kafka Connect 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 Kafka Connect is acting as a TLS/SSL server. The keystore must be in JKS format. ssl.keystore.location ssl_server_keystore_location false
Kafka Connect TLS/SSL Server JKS Keystore File Password The password for the Kafka Connect JKS keystore file. ssl.keystore.password.generator 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 Parameter Validation: Broker List for Kafka Connect Whether to suppress configuration warnings produced by the built-in parameter validation for the Broker List for Kafka Connect parameter. false role_config_suppression_bootstrap.servers true
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: config.storage.replication.factor Whether to suppress configuration warnings produced by the built-in parameter validation for the config.storage.replication.factor parameter. false role_config_suppression_config.storage.replication.factor true
Suppress Parameter Validation: config.storage.topic Whether to suppress configuration warnings produced by the built-in parameter validation for the config.storage.topic parameter. false role_config_suppression_config.storage.topic true
Suppress Parameter Validation: Kafka Connect Advanced Configuration Snippet (Safety Valve) for connect-distributed.properties Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Connect Advanced Configuration Snippet (Safety Valve) for connect-distributed.properties parameter. false role_config_suppression_connect-distributed.properties_role_safety_valve true
Suppress Parameter Validation: connect.log4j.connector.context Whether to suppress configuration warnings produced by the built-in parameter validation for the connect.log4j.connector.context parameter. false role_config_suppression_connector.context true
Suppress Parameter Validation: group.id Whether to suppress configuration warnings produced by the built-in parameter validation for the group.id parameter. false role_config_suppression_group.id true
Suppress Parameter Validation: Kafka Connect Configuration Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Connect Configuration Directory parameter. false role_config_suppression_kafka.connect.conf.directory 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_kafka.connect.jdk.home true
Suppress Parameter Validation: Kafka Connect Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Connect Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_kafka_connect_role_env_safety_valve true
Suppress Parameter Validation: KAFKA_HEAP_OPTS Whether to suppress configuration warnings produced by the built-in parameter validation for the KAFKA_HEAP_OPTS parameter. false role_config_suppression_kafka_heap_opts true
Suppress Parameter Validation: key.converter Whether to suppress configuration warnings produced by the built-in parameter validation for the key.converter parameter. false role_config_suppression_key.converter true
Suppress Parameter Validation: Kafka Connect Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Connect Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Kafka Connect Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Connect Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: metrics.jetty.server.port Whether to suppress configuration warnings produced by the built-in parameter validation for the metrics.jetty.server.port parameter. false role_config_suppression_metrics.jetty.server.port true
Suppress Parameter Validation: offset.storage.replication.factor Whether to suppress configuration warnings produced by the built-in parameter validation for the offset.storage.replication.factor parameter. false role_config_suppression_offset.storage.replication.factor true
Suppress Parameter Validation: offset.storage.topic Whether to suppress configuration warnings produced by the built-in parameter validation for the offset.storage.topic parameter. false role_config_suppression_offset.storage.topic 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: plugin.path Whether to suppress configuration warnings produced by the built-in parameter validation for the plugin.path parameter. false role_config_suppression_plugin.path true
Suppress Parameter Validation: rest.extension.classes Whether to suppress configuration warnings produced by the built-in parameter validation for the rest.extension.classes parameter. false role_config_suppression_rest.extension.classes true
Suppress Parameter Validation: kafka.connect.rest.port Whether to suppress configuration warnings produced by the built-in parameter validation for the kafka.connect.rest.port parameter. false role_config_suppression_rest.port 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: kafka.connect.secure.rest.port Whether to suppress configuration warnings produced by the built-in parameter validation for the kafka.connect.secure.rest.port parameter. false role_config_suppression_secure.rest.port true
Suppress Parameter Validation: Kafka Connect TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Connect TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Kafka Connect TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Connect TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Kafka Connect TLS/SSL Server JKS Keystore Key Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Connect TLS/SSL Server JKS Keystore Key Password parameter. false role_config_suppression_ssl_server_keystore_keypassword true
Suppress Parameter Validation: Kafka Connect TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Connect TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Kafka Connect TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Connect 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: status.storage.replication.factor Whether to suppress configuration warnings produced by the built-in parameter validation for the status.storage.replication.factor parameter. false role_config_suppression_status.storage.replication.factor true
Suppress Parameter Validation: status.storage.topic Whether to suppress configuration warnings produced by the built-in parameter validation for the status.storage.topic parameter. false role_config_suppression_status.storage.topic true
Suppress Parameter Validation: value.converter Whether to suppress configuration warnings produced by the built-in parameter validation for the value.converter parameter. false role_config_suppression_value.converter 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_kafka_kafka_connect_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_kafka_kafka_connect_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_kafka_kafka_connect_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_kafka_kafka_connect_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_kafka_kafka_connect_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_kafka_kafka_connect_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_kafka_kafka_connect_unexpected_exits true

Kafka MirrorMaker

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Kafka MirrorMaker 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. KAFKA_MIRROR_MAKER_role_env_safety_valve false
Kafka MirrorMaker Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for mirror_maker_consumers.properties For advanced use only. A string to be inserted into mirror_maker_consumers.properties for this role only. mirror_maker_consumers.properties_role_safety_valve false
Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for mirror_maker_producers.properties For advanced use only. A string to be inserted into mirror_maker_producers.properties for this role only. mirror_maker_producers.properties_role_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
Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for ssl_client.properties For advanced use only. A string to be inserted into ssl_client.properties for this role only. ssl_client.properties_role_safety_valve false
Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for ssl_server.properties For advanced use only. A string to be inserted into ssl_server.properties for this role only. ssl_server.properties_role_safety_valve false

Logs

Display Name Description Related Name Default Value API Name Required
Kafka MirrorMaker Log Directory The log directory for log files of the role Kafka MirrorMaker. kafka_mirrormaker.log4j.dir /var/log/kafka log_dir false
Kafka MirrorMaker Logging Threshold The minimum log level for Kafka MirrorMaker logs INFO log_threshold false
Kafka MirrorMaker Maximum Log File Backups The maximum number of rolled log files to keep for Kafka MirrorMaker logs. Typically used by log4j or logback. 10 max_log_backup_index false
Kafka MirrorMaker Max Log Size The maximum size, in megabytes, per log file for Kafka MirrorMaker 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
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 % kafka_mirror_maker_fd_thresholds false
Kafka MirrorMaker Host Health Test When computing the overall Kafka MirrorMaker health, consider the host's health. true kafka_mirror_maker_host_health_enabled false
Kafka MirrorMaker Process Health Test Enables the health test that the Kafka MirrorMaker's process state is consistent with the role configuration true kafka_mirror_maker_scm_health_enabled 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
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
Abort on Send Failure Stop the entire mirror maker when a send failure occurs. abort.on.send.failure true abort.on.send.failure false
Producer Batch Size This configuration controls the batch size in bytes. The producer will attempt to batch records together into fewer requests whenever multiple records are being sent to the same partition. This helps performance on both the client and the server. batch.size 16 KiB batch.size false
Destination Broker List Comma-separated list of IP:port (or hostname:port) pairs of brokers on destination cluster. This should be more than one, for high availability, but there's no need to list all brokers. bootstrap.servers bootstrap.servers true
Producer Buffer Memory The total bytes of memory the producer can use to buffer records waiting to be sent to the server. buffer.memory 32 MiB buffer.memory false
Producer Compression Type The compression type for all data generated by the producer. compression.type none compression.type false
MirrorMaker Consumer Rebalance Listener A consumer rebalance listener of the ConsumerRebalanceListener type. Invoked when MirrorMaker's consumer rebalances. consumer.rebalance.listener consumer.rebalance.listener false
MirrorMaker Consumer Rebalance Listener Arguments Arguments used by MirrorMaker consumer rebalance listener. consumer.rebalance.listener.args consumer.rebalance.listener.args false
Consumer Request Timeout The maximum amount of time the consumer will wait for the response of a request. If the response is not received before the timeout elapses, the consumer will resend the request if necessary or fail the request if retries are exhausted. consumer.request.timeout.ms 40 second(s) consumer.request.timeout.ms false
Destination Kafka Cluster's Security Protocol Protocol used for communication with destination Kafka cluster. destination.security.protocol PLAINTEXT destination.security.protocol false
Destination Kafka Cluster's Client Auth Only required if destination Kafka cluster requires client authentication. destination.ssl.client.auth false destination.ssl.client.auth false
Consumer Minimum Fetch Size The minimum amount of data the server should return for a fetch request. If insufficient data is available, the request will wait for that much data to accumulate before answering the request. Setting this property to something greater than 1 will cause the server to wait for larger amounts of data to accumulate which can improve server throughput a bit at the cost of some additional latency. fetch.min.bytes 1 B fetch.min.bytes false
Consumer Group ID Name of the consumer group used by MirrorMaker. When multiple role instances are configured with the same topics and same group ID, the role instances load-balance replication for the topics. When multiple role instances are configured with the same topics but different group ID, each role instance replicates all the events for those topics - this can be used to replicate the source cluster into multiple destination clusters. group.id cloudera_mirrormaker group.id false
Enable Authenticated Communication with the JMX Agent Enables Authenticated Communication with the JMX Agent. jmx.auth.enabled false jmx.auth.enabled false
Name of User with Read-Write Access to the JMX Agent Specifies the name of the user that has read-write privileges when using password file-based authentication for JMX access. JMX authentication must be enabled for this setting to take effect. jmx.control.user controlRole jmx.control.user false
Password of user with read-write access to the JMX agent Specifies the password of the user that has read-write privileges when using password file-based authentication for JMX access. JMX authentication must be enabled for this setting to take effect. jmx.control.user.passwd jmx.control.user.passwd false
Name of User with read-only access to the JMX Agent Specifies the name of the user that has read-only privileges when using password file-based authentication for JMX access. JMX authentication must be enabled for this setting to take effect. jmx.monitor.user monitorRole jmx.monitor.user false
Password of User with read-only Access to the JMX agent Specifies the password of the user that has read-only privileges when using password file-based authentication for JMX access. JMX authentication must be enabled for this setting to take effect. jmx.monitor.user.passwd jmx.monitor.user.passwd false
Enable TLS client authentication for JMX port If enabled, a valid client certificate must be presented by the JMX client in order to connect to the JMX port. Ensure that the trusted CA certificates are present in either the ZooKeeper JMX TLS/SSL Server Trust Store file or the global trust store. jmx.ssl.client.auth.enabled false jmx.ssl.client.auth.enabled false
Enable TLS/SSL for Kafka JMX Encrypt communication between clients and Kafka JMX using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). jmx.ssl.enabled false jmx.ssl.enabled false
Producer Linger Time The upper bound on the delay for batching. Once the producer gets a batch.size worth of records for a partition it will be sent immediately regardless of this setting. However, if fewer than this many bytes accumulated for this partition the producer will 'linger' for the specified time waiting for more records to show up. linger.ms 0 second(s) linger.ms false
MirrorMaker Message Handler A MirrorMaker message handler of the MirrorMakerMessageHandler type that will process every record in-between producer and consumer. message.handler message.handler false
MirrorMaker Message Handler Arguments Arguments used by MirrorMaker message handler. message.handler.args message.handler.args false
Additional MirrorMaker Java Options These arguments are passed as part of the Java command line. Commonly, garbage collection flags or extra debugging flags are passed here. mirror_maker_java_opts -server -XX:+UseG1GC -XX:MaxGCPauseMillis=20 -XX:InitiatingHeapOccupancyPercent=35 -XX:G1HeapRegionSize=16M -XX:MinMetaspaceFreeRatio=50 -XX:MaxMetaspaceFreeRatio=80 -XX:+DisableExplicitGC -Djava.awt.headless=true -Djava.net.preferIPv4Stack=true -Dcom.sun.management.jmxremote.host=127.0.0.1 -Dcom.sun.management.jmxremote.local.only=true -Djava.rmi.server.hostname=127.0.0.1 mirror_maker_java_opts false
Java Heap Size of MirrorMaker Maximum size for the Java process heap memory. Passed to Java -Xmx. Measured in megabytes. mirror_maker_max_heap_size 1 GiB mirror_maker_max_heap_size false
Number of Consumer Threads Number of consumer threads. num.streams 1 num.streams false
Offset Commit Interval Offset commit interval in milliseconds. offset.commit.interval.ms 60000 offset.commit.interval.ms false
Producer Request Timeout The maximum amount of time the producer will wait for the response of a request. If the response is not received before the timeout elapses, the producer will resend the request if necessary or fail the request if retries are exhausted. producer.request.timeout.ms 30 second(s) producer.request.timeout.ms false
Consumer Session Timeout The timeout used to detect failures when using the group management facilities of Kafka. When the heartbeat of a consumer is not received within the session timeout, the broker will mark the consumer as failed and rebalance the group. Note that the value must be in the allowable range as configured in the broker by group.min.session.timeout.ms and group.max.session.timeout.ms. session.timeout.ms 30 second(s) session.timeout.ms false
Source Broker List Comma-separated list of IP:port (or hostname:port) pairs of brokers on source cluster. This should be more than one, for high availability, but there's no need to list all brokers. source.bootstrap.servers source.bootstrap.servers true
Source Kafka Cluster's Security Protocol Protocol used for communication with source Kafka cluster. source.security.protocol PLAINTEXT source.security.protocol false
Source Kafka Cluster's Client Auth Only required if the source Kafka cluster requires client authentication. source.ssl.client.auth false source.ssl.client.auth false
Topic Whitelist Regular expression that represents a set of topics to mirror. whitelist whitelist 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

Ports and Addresses

Display Name Description Related Name Default Value API Name Required
JMX Port Port for JMX. jmx_port 9394 jmx_port 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
Kafka MirrorMaker 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 Kafka MirrorMaker might connect to. This is used when Kafka MirrorMaker is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead. ssl.truststore.location ssl_client_truststore_location false
Kafka MirrorMaker TLS/SSL Client Trust Store Password The password for the Kafka MirrorMaker TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. ssl.truststore.password.generator ssl_client_truststore_password false
Enable TLS/SSL for Kafka MirrorMaker Encrypt communication between clients and Kafka MirrorMaker using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). ssl_enabled false ssl_enabled false
Kafka MirrorMaker TLS/SSL Server JKS Keystore Key Password The password that protects the private key contained in the JKS keystore used when Kafka MirrorMaker is acting as a TLS/SSL server. ssl.key.password.generator ssl_server_keystore_keypassword false
Kafka MirrorMaker 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 Kafka MirrorMaker is acting as a TLS/SSL server. The keystore must be in JKS format. ssl.keystore.location ssl_server_keystore_location false
Kafka MirrorMaker TLS/SSL Server JKS Keystore File Password The password for the Kafka MirrorMaker JKS keystore file. ssl.keystore.password.generator 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 Parameter Validation: Destination Broker List Whether to suppress configuration warnings produced by the built-in parameter validation for the Destination Broker List parameter. false role_config_suppression_bootstrap.servers true
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: MirrorMaker Consumer Rebalance Listener Whether to suppress configuration warnings produced by the built-in parameter validation for the MirrorMaker Consumer Rebalance Listener parameter. false role_config_suppression_consumer.rebalance.listener true
Suppress Parameter Validation: MirrorMaker Consumer Rebalance Listener Arguments Whether to suppress configuration warnings produced by the built-in parameter validation for the MirrorMaker Consumer Rebalance Listener Arguments parameter. false role_config_suppression_consumer.rebalance.listener.args true
Suppress Parameter Validation: Consumer Group ID Whether to suppress configuration warnings produced by the built-in parameter validation for the Consumer Group ID parameter. false role_config_suppression_group.id true
Suppress Parameter Validation: Name of User with Read-Write Access to the JMX Agent Whether to suppress configuration warnings produced by the built-in parameter validation for the Name of User with Read-Write Access to the JMX Agent parameter. false role_config_suppression_jmx.control.user true
Suppress Parameter Validation: Password of user with read-write access to the JMX agent Whether to suppress configuration warnings produced by the built-in parameter validation for the Password of user with read-write access to the JMX agent parameter. false role_config_suppression_jmx.control.user.passwd true
Suppress Parameter Validation: Name of User with read-only access to the JMX Agent Whether to suppress configuration warnings produced by the built-in parameter validation for the Name of User with read-only access to the JMX Agent parameter. false role_config_suppression_jmx.monitor.user true
Suppress Parameter Validation: Password of User with read-only Access to the JMX agent Whether to suppress configuration warnings produced by the built-in parameter validation for the Password of User with read-only Access to the JMX agent parameter. false role_config_suppression_jmx.monitor.user.passwd true
Suppress Parameter Validation: JMX Port Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Port parameter. false role_config_suppression_jmx_port true
Suppress Parameter Validation: Kafka MirrorMaker Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka MirrorMaker Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_kafka_mirror_maker_role_env_safety_valve true
Suppress Parameter Validation: Kafka MirrorMaker Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka MirrorMaker Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Kafka MirrorMaker Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka MirrorMaker Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: MirrorMaker Message Handler Whether to suppress configuration warnings produced by the built-in parameter validation for the MirrorMaker Message Handler parameter. false role_config_suppression_message.handler true
Suppress Parameter Validation: MirrorMaker Message Handler Arguments Whether to suppress configuration warnings produced by the built-in parameter validation for the MirrorMaker Message Handler Arguments parameter. false role_config_suppression_message.handler.args true
Suppress Parameter Validation: Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for mirror_maker_consumers.properties Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for mirror_maker_consumers.properties parameter. false role_config_suppression_mirror_maker_consumers.properties_role_safety_valve true
Suppress Parameter Validation: Additional MirrorMaker Java Options Whether to suppress configuration warnings produced by the built-in parameter validation for the Additional MirrorMaker Java Options parameter. false role_config_suppression_mirror_maker_java_opts true
Suppress Parameter Validation: Java Heap Size of MirrorMaker Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of MirrorMaker parameter. false role_config_suppression_mirror_maker_max_heap_size true
Suppress Parameter Validation: Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for mirror_maker_producers.properties Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for mirror_maker_producers.properties parameter. false role_config_suppression_mirror_maker_producers.properties_role_safety_valve true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: Source Broker List Whether to suppress configuration warnings produced by the built-in parameter validation for the Source Broker List parameter. false role_config_suppression_source.bootstrap.servers true
Suppress Parameter Validation: Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for ssl_client.properties Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for ssl_client.properties parameter. false role_config_suppression_ssl_client.properties_role_safety_valve true
Suppress Parameter Validation: Kafka MirrorMaker TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka MirrorMaker TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Kafka MirrorMaker TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka MirrorMaker TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for ssl_server.properties Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for ssl_server.properties parameter. false role_config_suppression_ssl_server.properties_role_safety_valve true
Suppress Parameter Validation: Kafka MirrorMaker TLS/SSL Server JKS Keystore Key Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka MirrorMaker TLS/SSL Server JKS Keystore Key Password parameter. false role_config_suppression_ssl_server_keystore_keypassword true
Suppress Parameter Validation: Kafka MirrorMaker TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka MirrorMaker TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Kafka MirrorMaker TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka MirrorMaker 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: Topic Whitelist Whether to suppress configuration warnings produced by the built-in parameter validation for the Topic Whitelist parameter. false role_config_suppression_whitelist 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_kafka_kafka_mirror_maker_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_kafka_kafka_mirror_maker_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_kafka_kafka_mirror_maker_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_kafka_kafka_mirror_maker_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_kafka_kafka_mirror_maker_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_kafka_kafka_mirror_maker_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_kafka_kafka_mirror_maker_unexpected_exits true

Service-Wide

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Kafka 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. KAFKA_service_env_safety_valve false
System Group The group that this service's processes should run as. kafka process_groupname true
System User The user that this service's processes should run as. kafka process_username 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
Healthy Kafka Broker Monitoring Thresholds The health test thresholds of the overall Kafka Broker health. The check returns "Concerning" health if the percentage of "Healthy" Kafka Brokers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Kafka Brokers falls below the critical threshold. Warning: 94.99 %, Critical: 49.99 % KAFKA_KAFKA_BROKER_healthy_thresholds 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

Other

Display Name Description Related Name Default Value API Name Required
Topic Auto Creation Enables auto creation of topics on the server. If set to true, it attempts to produce, consume, or fetch metadata for a non-existent topic automatically create the topic with the default replication factor and number of partitions. auto.create.topics.enable true auto.create.topics.enable false
Enable Automatic Leader Rebalancing If automatic leader rebalancing is enabled, the controller tries to balance leadership for partitions among the brokers by periodically returning leadership for each partition to the preferred replica, if that replica is available. auto.leader.rebalance.enable true auto.leader.rebalance.enable false
Enable Controlled Shutdown Enables controlled shutdown of the broker. If enabled, the broker moves all leaders on it to other brokers before shutting itself down. This reduces the unavailability window during shutdown. controlled.shutdown.enable true controlled.shutdown.enable false
Controlled Shutdown Maximum Attempts Number of unsuccessful controlled shutdown attempts before executing an unclean shutdown. For example, the default value of 3 means that the system will attempt a controlled shutdown 3 times before executing an unclean shutdown. controlled.shutdown.max.retries 3 controlled.shutdown.max.retries false
Default Replication Factor The default replication factor for automatically created topics. default.replication.factor 1 default.replication.factor false
Enable Delegation Tokens Enables authentication with delegation tokens for this Kafka service. When enabled, a secure password is automatically generated and used as the "delegation.token.master.key" property for Kafka Brokers. Only allowed if Kerberos authentication is enabled. delegation.token.enable true delegation.token.enable false
Delegation Token Expiry Time The expiry time of a delegation token. A delegation token can be renewed before its expiry time to extend its validity up to its maximum lifetime. If it is not renewed, it will expire even if it has time remaining from its maximum lifetime. delegation.token.expiry.time.ms 1 day(s) delegation.token.expiry.time.ms false
Delegation Token Maximum Lifetime The maximum amount of time that a delegation token can be valid for. delegation.token.max.lifetime.ms 7 day(s) delegation.token.max.lifetime.ms false
Enable Delete Topic Enables topic deletion using admin tools. When delete topic is disabled, deleting topics through the admin tools has no effect. delete.topic.enable true delete.topic.enable false
Consumer Group Maximum Session Timeout The minimum allowed session timeout for registered consumers. Shorter timeouts result in quicker failure detection at the cost of more frequent consumer heartbeating, which can overwhelm broker resources. group.max.session.timeout.ms 30 minute(s) group.max.session.timeout.ms false
Consumer Group Minimum Session Timeout The minimum allowed session timeout for registered consumers. Shorter timeouts result in quicker failure detection at the cost of more frequent consumer heartbeating, which can overwhelm broker resources. group.min.session.timeout.ms 6 second(s) group.min.session.timeout.ms false
HDFS Service Name of the HDFS service that this Kafka service instance depends on hdfs_service false
List of Metric Reporters List of metric reporter class names. HTTP reporter is included by default. kafka.metrics.reporters nl.techop.kafka.KafkaHttpMetricsReporter kafka.metrics.reporters false
Enable Kerberos Authentication Enables Kerberos authentication for this Kafka service. kerberos.auth.enable false kerberos.auth.enable false
LDAP URL The URL of LDAP for authenticating Kafka clients. ldap.auth.url ldap.auth.url false
LDAP User DN Template The LDAP user DN template for authenticating Kafka clients. ldap.auth.user.dn.template ldap.auth.user.dn.template false
Leader Imbalance Check Interval Defines the frequency of leader imbalance checks. leader.imbalance.check.interval.seconds 5 minute(s) leader.imbalance.check.interval.seconds false
Leader Imbalance Allowed Per Broker The percentage of leader imbalance allowed per broker. The controller rebalances leadership if the leader imbalance ratio goes above the configured value per broker. leader.imbalance.per.broker.percentage 10 % leader.imbalance.per.broker.percentage false
Log Cleaner Deduplication Buffer Size The total memory used for log deduplication across all cleaner threads. This memory is statically allocated and will not cause GC problems. log.cleaner.dedupe.buffer.size 128 MiB log.cleaner.dedupe.buffer.size false
Log Compaction Delete Record Retention Time The amount of time to retain delete messages for log compacted topics. Once a consumer has seen an original message, it has to be ensured that it also sees the delete message. If the delete message is removed too quickly, this might not happen. The configurable delete retention time helps to circumvent this issue. log.cleaner.delete.retention.ms 7 day(s) log.cleaner.delete.retention.ms false
Enable Log Compaction Enables the log cleaner to compact topics with cleanup.policy=compact on this cluster. log.cleaner.enable true log.cleaner.enable false
Log Cleaner Clean Ratio Controls how frequently the log cleaner will attempt to clean the log. This ratio restricts the maximum space wasted by duplicates in the log. For example, if set to 0.5, then at most 50% of the log can be populated by duplicates. A higher ratio results in fewer, more efficient cleaning processes, but more wasted space in the log. log.cleaner.min.cleanable.ratio 0.5 log.cleaner.min.cleanable.ratio false
Number of Log Cleaner Threads The number of background threads used for log cleaning. log.cleaner.threads 1 log.cleaner.threads false
Log Flush Message Interval The number of messages written to a log partition before triggering an fsync on the log. Setting this property to a low value results in more frequent data to disk synchronization, but also has major impact on performance. For durability, Cloudera recommends the use of replication rather than depending on a single-server fsync. However, this setting can be used as an extra safety measure. If used in conjunction with log.flush.interval.ms, the log is flushed when either criteria is met. log.flush.interval.messages log.flush.interval.messages false
Log Flush Time Interval The maximum time between fsync calls on the log. If used in conjunction with log.flush.interval.messages, the log is flushed when either criteria is met. log.flush.interval.ms log.flush.interval.ms false
Log Flush Scheduler Interval The frequency, in milliseconds, with which the log flusher checks whether any log is eligible to be flushed to disk. log.flush.scheduler.interval.ms log.flush.scheduler.interval.ms false
Maximum Message Size The maximum size of a message that the server can receive. This property has to be in sync with the maximum fetch size the consumers use. Otherwise, an unruly producer could publish messages that are too large for consumption. message.max.bytes 1000000 B message.max.bytes false
Minimum Number of Replicas in ISR The minimum number of replicas in the in-sync replica needed to satisfy a produce request where required.acks=-1 (that is, all). min.insync.replicas 1 min.insync.replicas false
Enable Kafka Monitoring Enables Kafka monitoring. monitoring.enabled true monitoring.enabled false
Default Number of Partitions The default number of partitions for automatically created topics. num.partitions 1 num.partitions false
Number of Replica Fetchers Number of threads used to replicate messages from leaders. Increasing this value increases the degree of I/O parallelism in the follower broker. num.replica.fetchers 4 num.replica.fetchers false
Offset Retention Time After a consumer group loses all its consumers (i.e. becomes empty) its offsets will be kept for this retention period before getting discarded. For standalone consumers (using manual assignment), offsets will be expired after the time of last commit plus this retention period. offsets.retention.minutes 7 day(s) offsets.retention.minutes false
Offset Commit Topic Number of Partitions The number of partitions for the offset commit topic. Changing this value after deployment is currently unsupported, therefore, Cloudera recommends using a higher number of partitions (for example, 100-200) for production. offsets.topic.num.partitions 50 offsets.topic.num.partitions false
Offset Commit Topic Replication Factor The replication factor for the offset commit topic. A higher setting (for example, 3 or 4) is recommended in order to ensure higher availability. If the offsets topic is created when there are fewer brokers than the replication factor, then the offsets topic is created with fewer replicas. offsets.topic.replication.factor 3 offsets.topic.replication.factor false
PAM Service The PAM service name for authenticating Kafka clients. This corresponds to the service name in the PAM configuration. pam.auth.service login pam.auth.service false
Enable Producer Metrics Enables producer metrics producer.metrics.enable true producer.metrics.enable false
Default Consumer Quota Any consumer distinguished by clientId/consumer group will get throttled if it fetches more bytes than this value per-second. quota.consumer.default quota.consumer.default false
Default Producer Quota Any producer distinguished by clientId will get throttled if it produces more bytes than this value per-second. quota.producer.default quota.producer.default false
Ranger Kafka Plugin Hdfs Audit Directory The DFS path on which Ranger audits are written. ranger_kafka_plugin_hdfs_audit_directory $ranger_base_audit_url/kafka ranger_kafka_plugin_hdfs_audit_directory false
'Ranger service' name for this Kafka service Name of the 'Ranger service', that is used for authorization by this Kafka service. If this parameter is set to the placeholder value '{{GENERATED_RANGER_SERVICE_NAME}}', a generated service name will be used, and if necessary, created. The generated service name will refer to the name of the cluster and the name of this Kafka service. The name can consist of alphanumeric and '_' characters. ranger.plugin.kafka.service.name cm_kafka ranger_plugin_kafka_service_name false
RANGER Service Name of the RANGER service that this Kafka service instance depends on ranger_service false
Replica Maximum Fetch Size The maximum number of bytes to fetch for each partition in fetch requests that replicas send to the leader. This value should be larger than message.max.bytes. replica.fetch.max.bytes 1 MiB replica.fetch.max.bytes false
Allowed Replica Time Lag If a follower has not sent any fetch requests, nor has it consumed up to the leader's log end offset during this time, the leader removes the follower from the ISR set. replica.lag.time.max.ms 10 second(s) replica.lag.time.max.ms false
SASL/PLAIN Authentication Authentication method that the SASL/PLAIN mechanism uses to authenticate clients. sasl.plain.auth none sasl.plain.auth false
Minimum Number of Replicas in ISR for Transaction State Log Overridden min.insync.replicas config for the transaction topic. transaction.state.log.min.isr 2 transaction.state.log.min.isr false
Transaction State Log Replication Factor The replication factor for the transaction topic (set higher to ensure availability). Internal topic creation will fail until the cluster size meets this replication factor requirement. transaction.state.log.replication.factor 3 transaction.state.log.replication.factor false
Enable Unclean Leader Election Enables replicas not in the ISR set to be elected as leader as a last resort, even though doing so might result in data loss. unclean.leader.election.enable false unclean.leader.election.enable false
ZooKeeper Root The znode in ZooKeeper used as a root for this Kafka cluster. zookeeper.chroot /kafka zookeeper.chroot false
Enable Secure Connection to ZooKeeper Enables SSL/TLS connection to ZooKeeper for this Kafka service if dependent ZooKeeper service's zookeeper_tls_enabled configuration is enabled. zookeeper.secure.connection.enable true zookeeper.secure.connection.enable false
ZooKeeper Session Timeout If the server fails to send a heartbeat to ZooKeeper within this period of time, it is considered dead. If set to a too low value, ZooKeeper might falsely consider a server dead. If set to a too high value, ZooKeeper might take too long to recognize a dead server. zookeeper.session.timeout.ms 6 second(s) zookeeper.session.timeout.ms false
ZooKeeper Service Name of the ZooKeeper service that this Kafka service instance depends on zookeeper_service true

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: Advertised Host Whether to suppress configuration warnings produced by the Advertised Host configuration validator. false role_config_suppression_advertised.host.name true
Suppress Configuration Validator: Advertised Port Whether to suppress configuration warnings produced by the Advertised Port configuration validator. false role_config_suppression_advertised.port true
Suppress Configuration Validator: Destination Broker List Whether to suppress configuration warnings produced by the Destination Broker List configuration validator. false role_config_suppression_bootstrap.servers true
Suppress Configuration Validator: Broker ID Whether to suppress configuration warnings produced by the Broker ID configuration validator. false role_config_suppression_broker.id true
Suppress Configuration Validator: Additional Broker Java Options Whether to suppress configuration warnings produced by the Additional Broker Java Options configuration validator. false role_config_suppression_broker_java_opts true
Suppress Configuration Validator: Java Heap Size of Broker Whether to suppress configuration warnings produced by the Java Heap Size of Broker configuration validator. false role_config_suppression_broker_max_heap_size true
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Configuration Validator: Deploy Directory Whether to suppress configuration warnings produced by the Deploy Directory configuration validator. false role_config_suppression_client_config_root_dir true
Suppress Configuration Validator: config.storage.replication.factor Whether to suppress configuration warnings produced by the config.storage.replication.factor configuration validator. false role_config_suppression_config.storage.replication.factor true
Suppress Configuration Validator: config.storage.topic Whether to suppress configuration warnings produced by the config.storage.topic configuration validator. false role_config_suppression_config.storage.topic true
Suppress Configuration Validator: Kafka Connect Advanced Configuration Snippet (Safety Valve) for connect-distributed.properties Whether to suppress configuration warnings produced by the Kafka Connect Advanced Configuration Snippet (Safety Valve) for connect-distributed.properties configuration validator. false role_config_suppression_connect-distributed.properties_role_safety_valve true
Suppress Configuration Validator: connect.log4j.connector.context Whether to suppress configuration warnings produced by the connect.log4j.connector.context configuration validator. false role_config_suppression_connector.context true
Suppress Configuration Validator: MirrorMaker Consumer Rebalance Listener Whether to suppress configuration warnings produced by the MirrorMaker Consumer Rebalance Listener configuration validator. false role_config_suppression_consumer.rebalance.listener true
Suppress Configuration Validator: MirrorMaker Consumer Rebalance Listener Arguments Whether to suppress configuration warnings produced by the MirrorMaker Consumer Rebalance Listener Arguments configuration validator. false role_config_suppression_consumer.rebalance.listener.args true
Suppress Configuration Validator: Consumer Group ID Whether to suppress configuration warnings produced by the Consumer Group ID configuration validator. false role_config_suppression_group.id true
Suppress Configuration Validator: Name of User with Read-Write Access to the JMX Agent Whether to suppress configuration warnings produced by the Name of User with Read-Write Access to the JMX Agent configuration validator. false role_config_suppression_jmx.control.user true
Suppress Configuration Validator: Password of user with read-write access to the JMX agent Whether to suppress configuration warnings produced by the Password of user with read-write access to the JMX agent configuration validator. false role_config_suppression_jmx.control.user.passwd true
Suppress Configuration Validator: Name of User with read-only access to the JMX Agent Whether to suppress configuration warnings produced by the Name of User with read-only access to the JMX Agent configuration validator. false role_config_suppression_jmx.monitor.user true
Suppress Configuration Validator: Password of User with read-only Access to the JMX agent Whether to suppress configuration warnings produced by the Password of User with read-only Access to the JMX agent configuration validator. false role_config_suppression_jmx.monitor.user.passwd true
Suppress Configuration Validator: JMX Port Whether to suppress configuration warnings produced by the JMX Port configuration validator. false role_config_suppression_jmx_port true
Suppress Configuration Validator: Kafka Client Advanced Configuration Snippet (Safety Valve) for kafka-conf/kafka-client.conf Whether to suppress configuration warnings produced by the Kafka Client Advanced Configuration Snippet (Safety Valve) for kafka-conf/kafka-client.conf configuration validator. false role_config_suppression_kafka-conf/kafka-client.conf_client_config_safety_valve true
Suppress Configuration Validator: Kafka Client Advanced Configuration Snippet (Safety Valve) for kafka-conf/kafka-cluster-configs.properties Whether to suppress configuration warnings produced by the Kafka Client Advanced Configuration Snippet (Safety Valve) for kafka-conf/kafka-cluster-configs.properties configuration validator. false role_config_suppression_kafka-conf/kafka-cluster-configs.properties_client_config_safety_valve true
Suppress Configuration Validator: Kafka Client Advanced Configuration Snippet (Safety Valve) for kafka-conf/kafka-ranger-repo.properties Whether to suppress configuration warnings produced by the Kafka Client Advanced Configuration Snippet (Safety Valve) for kafka-conf/kafka-ranger-repo.properties configuration validator. false role_config_suppression_kafka-conf/kafka-ranger-repo.properties_client_config_safety_valve true
Suppress Configuration Validator: Kafka Broker Advanced Configuration Snippet (Safety Valve) for kafka-monitoring.properties Whether to suppress configuration warnings produced by the Kafka Broker Advanced Configuration Snippet (Safety Valve) for kafka-monitoring.properties configuration validator. false role_config_suppression_kafka-monitoring.properties_role_safety_valve true
Suppress Configuration Validator: Kafka Connect Configuration Directory Whether to suppress configuration warnings produced by the Kafka Connect Configuration Directory configuration validator. false role_config_suppression_kafka.connect.conf.directory 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_kafka.connect.jdk.home true
Suppress Configuration Validator: HTTP Metric Report Host Whether to suppress configuration warnings produced by the HTTP Metric Report Host configuration validator. false role_config_suppression_kafka.http.metrics.host true
Suppress Configuration Validator: HTTP Metric Report Port Whether to suppress configuration warnings produced by the HTTP Metric Report Port configuration validator. false role_config_suppression_kafka.http.metrics.port true
Suppress Configuration Validator: Kafka Broker Advanced Configuration Snippet (Safety Valve) for kafka.properties Whether to suppress configuration warnings produced by the Kafka Broker Advanced Configuration Snippet (Safety Valve) for kafka.properties configuration validator. false role_config_suppression_kafka.properties_role_safety_valve true
Suppress Configuration Validator: Kafka Broker Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Kafka Broker Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_kafka_broker_role_env_safety_valve true
Suppress Configuration Validator: Kafka Connect Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Kafka Connect Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_kafka_connect_role_env_safety_valve true
Suppress Configuration Validator: KAFKA_HEAP_OPTS Whether to suppress configuration warnings produced by the KAFKA_HEAP_OPTS configuration validator. false role_config_suppression_kafka_heap_opts true
Suppress Configuration Validator: Kafka MirrorMaker Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Kafka MirrorMaker Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_kafka_mirror_maker_role_env_safety_valve true
Suppress Configuration Validator: key.converter Whether to suppress configuration warnings produced by the key.converter configuration validator. false role_config_suppression_key.converter true
Suppress Configuration Validator: Data Directories Whether to suppress configuration warnings produced by the Data Directories configuration validator. false role_config_suppression_log.dirs true
Suppress Configuration Validator: Segment File Size Whether to suppress configuration warnings produced by the Segment File Size configuration validator. false role_config_suppression_log.segment.bytes true
Suppress Configuration Validator: Kafka Broker Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Kafka Broker Logging Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_log4j_safety_valve true
Suppress Configuration Validator: Kafka Broker Log Directory Whether to suppress configuration warnings produced by the Kafka Broker Log Directory configuration validator. false role_config_suppression_log_dir true
Suppress Configuration Validator: MirrorMaker Message Handler Whether to suppress configuration warnings produced by the MirrorMaker Message Handler configuration validator. false role_config_suppression_message.handler true
Suppress Configuration Validator: MirrorMaker Message Handler Arguments Whether to suppress configuration warnings produced by the MirrorMaker Message Handler Arguments configuration validator. false role_config_suppression_message.handler.args true
Suppress Configuration Validator: metrics.jetty.server.port Whether to suppress configuration warnings produced by the metrics.jetty.server.port configuration validator. false role_config_suppression_metrics.jetty.server.port true
Suppress Configuration Validator: Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for mirror_maker_consumers.properties Whether to suppress configuration warnings produced by the Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for mirror_maker_consumers.properties configuration validator. false role_config_suppression_mirror_maker_consumers.properties_role_safety_valve true
Suppress Configuration Validator: Additional MirrorMaker Java Options Whether to suppress configuration warnings produced by the Additional MirrorMaker Java Options configuration validator. false role_config_suppression_mirror_maker_java_opts true
Suppress Configuration Validator: Java Heap Size of MirrorMaker Whether to suppress configuration warnings produced by the Java Heap Size of MirrorMaker configuration validator. false role_config_suppression_mirror_maker_max_heap_size true
Suppress Configuration Validator: Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for mirror_maker_producers.properties Whether to suppress configuration warnings produced by the Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for mirror_maker_producers.properties configuration validator. false role_config_suppression_mirror_maker_producers.properties_role_safety_valve true
Suppress Configuration Validator: Number of I/O Threads Whether to suppress configuration warnings produced by the Number of I/O Threads configuration validator. false role_config_suppression_num.io.threads true
Suppress Configuration Validator: Number of Network Threads Whether to suppress configuration warnings produced by the Number of Network Threads configuration validator. false role_config_suppression_num.network.threads true
Suppress Configuration Validator: Number of Recovery Threads per data directory Whether to suppress configuration warnings produced by the Number of Recovery Threads per data directory configuration validator. false role_config_suppression_num.recovery.threads.per.data.dir true
Suppress Configuration Validator: Number of Alter Log Dir Threads Whether to suppress configuration warnings produced by the Number of Alter Log Dir Threads configuration validator. false role_config_suppression_num.replica.alter.log.dirs.threads true
Suppress Configuration Validator: offset.storage.replication.factor Whether to suppress configuration warnings produced by the offset.storage.replication.factor configuration validator. false role_config_suppression_offset.storage.replication.factor true
Suppress Configuration Validator: offset.storage.topic Whether to suppress configuration warnings produced by the offset.storage.topic configuration validator. false role_config_suppression_offset.storage.topic 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: plugin.path Whether to suppress configuration warnings produced by the plugin.path configuration validator. false role_config_suppression_plugin.path true
Suppress Configuration Validator: TCP Port Whether to suppress configuration warnings produced by the TCP Port configuration validator. false role_config_suppression_port true
Suppress Configuration Validator: Kafka Broker Advanced Configuration Snippet (Safety Valve) for ranger-kafka-audit.xml Whether to suppress configuration warnings produced by the Kafka Broker 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: Kafka Broker Advanced Configuration Snippet (Safety Valve) for ranger-kafka-policymgr-ssl.xml Whether to suppress configuration warnings produced by the Kafka Broker 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: Kafka Broker Advanced Configuration Snippet (Safety Valve) for ranger-kafka-security.xml Whether to suppress configuration warnings produced by the Kafka Broker 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: Ranger Kafka Plugin Conf Path Whether to suppress configuration warnings produced by the Ranger Kafka Plugin Conf Path configuration validator. false role_config_suppression_ranger_kafka_plugin_conf_path true
Suppress Configuration Validator: Ranger Kafka Plugin Audit Hdfs Spool Directory Path Whether to suppress configuration warnings produced by the Ranger Kafka Plugin Audit Hdfs Spool Directory Path configuration validator. false role_config_suppression_ranger_kafka_plugin_hdfs_audit_spool_directory true
Suppress Configuration Validator: Ranger Kafka Plugin Policy Cache Directory Path Whether to suppress configuration warnings produced by the Ranger Kafka Plugin Policy Cache Directory Path configuration validator. false role_config_suppression_ranger_kafka_plugin_policy_cache_directory true
Suppress Configuration Validator: Ranger Kafka Plugin Audit Solr Spool Directory Path Whether to suppress configuration warnings produced by the Ranger Kafka Plugin Audit Solr Spool Directory Path configuration validator. false role_config_suppression_ranger_kafka_plugin_solr_audit_spool_directory true
Suppress Configuration Validator: Ranger Plugin Trusted Proxy IP Address Whether to suppress configuration warnings produced by the Ranger Plugin Trusted Proxy IP Address configuration validator. false role_config_suppression_ranger_plugin_trusted_proxy_ipaddress true
Suppress Configuration Validator: rest.extension.classes Whether to suppress configuration warnings produced by the rest.extension.classes configuration validator. false role_config_suppression_rest.extension.classes true
Suppress Configuration Validator: kafka.connect.rest.port Whether to suppress configuration warnings produced by the kafka.connect.rest.port configuration validator. false role_config_suppression_rest.port 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: kafka.connect.secure.rest.port Whether to suppress configuration warnings produced by the kafka.connect.secure.rest.port configuration validator. false role_config_suppression_secure.rest.port true
Suppress Configuration Validator: Source Broker List Whether to suppress configuration warnings produced by the Source Broker List configuration validator. false role_config_suppression_source.bootstrap.servers true
Suppress Configuration Validator: Kafka Broker Advanced Configuration Snippet (Safety Valve) for ssl.properties Whether to suppress configuration warnings produced by the Kafka Broker Advanced Configuration Snippet (Safety Valve) for ssl.properties configuration validator. false role_config_suppression_ssl.properties_role_safety_valve true
Suppress Configuration Validator: Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for ssl_client.properties Whether to suppress configuration warnings produced by the Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for ssl_client.properties configuration validator. false role_config_suppression_ssl_client.properties_role_safety_valve true
Suppress Configuration Validator: Kafka Broker TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the Kafka Broker TLS/SSL Client Trust Store File configuration validator. false role_config_suppression_ssl_client_truststore_location true
Suppress Configuration Validator: Kafka Broker TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the Kafka Broker TLS/SSL Client Trust Store Password configuration validator. false role_config_suppression_ssl_client_truststore_password true
Suppress Configuration Validator: TLS/SSL Port Whether to suppress configuration warnings produced by the TLS/SSL Port configuration validator. false role_config_suppression_ssl_port true
Suppress Configuration Validator: Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for ssl_server.properties Whether to suppress configuration warnings produced by the Kafka MirrorMaker Advanced Configuration Snippet (Safety Valve) for ssl_server.properties configuration validator. false role_config_suppression_ssl_server.properties_role_safety_valve true
Suppress Configuration Validator: Kafka Broker TLS/SSL Server JKS Keystore Key Password Whether to suppress configuration warnings produced by the Kafka Broker TLS/SSL Server JKS Keystore Key Password configuration validator. false role_config_suppression_ssl_server_keystore_keypassword true
Suppress Configuration Validator: Kafka Broker TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the Kafka Broker TLS/SSL Server JKS Keystore File Location configuration validator. false role_config_suppression_ssl_server_keystore_location true
Suppress Configuration Validator: Kafka Broker TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the Kafka Broker TLS/SSL Server JKS Keystore File Password configuration validator. false role_config_suppression_ssl_server_keystore_password true
Suppress Configuration Validator: Stacks Collection Directory Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator. false role_config_suppression_stacks_collection_directory true
Suppress Configuration Validator: status.storage.replication.factor Whether to suppress configuration warnings produced by the status.storage.replication.factor configuration validator. false role_config_suppression_status.storage.replication.factor true
Suppress Configuration Validator: status.storage.topic Whether to suppress configuration warnings produced by the status.storage.topic configuration validator. false role_config_suppression_status.storage.topic true
Suppress Configuration Validator: value.converter Whether to suppress configuration warnings produced by the value.converter configuration validator. false role_config_suppression_value.converter true
Suppress Configuration Validator: Topic Whitelist Whether to suppress configuration warnings produced by the Topic Whitelist configuration validator. false role_config_suppression_whitelist true
Suppress Parameter Validation: Controlled Shutdown Maximum Attempts Whether to suppress configuration warnings produced by the built-in parameter validation for the Controlled Shutdown Maximum Attempts parameter. false service_config_suppression_controlled.shutdown.max.retries true
Suppress Parameter Validation: Default Replication Factor Whether to suppress configuration warnings produced by the built-in parameter validation for the Default Replication Factor parameter. false service_config_suppression_default.replication.factor true
Suppress Configuration Validator: Gateway Count Validator Whether to suppress configuration warnings produced by the Gateway Count Validator configuration validator. false service_config_suppression_gateway_count_validator true
Suppress Parameter Validation: List of Metric Reporters Whether to suppress configuration warnings produced by the built-in parameter validation for the List of Metric Reporters parameter. false service_config_suppression_kafka.metrics.reporters true
Suppress Configuration Validator: Kafka Broker Count Validator Whether to suppress configuration warnings produced by the Kafka Broker Count Validator configuration validator. false service_config_suppression_kafka_broker_count_validator true
Suppress Configuration Validator: Kafka Connect Count Validator Whether to suppress configuration warnings produced by the Kafka Connect Count Validator configuration validator. false service_config_suppression_kafka_connect_count_validator true
Suppress Configuration Validator: Kafka MirrorMaker Count Validator Whether to suppress configuration warnings produced by the Kafka MirrorMaker Count Validator configuration validator. false service_config_suppression_kafka_mirror_maker_count_validator true
Suppress Parameter Validation: Kafka Service Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Service Environment Advanced Configuration Snippet (Safety Valve) parameter. false service_config_suppression_kafka_service_env_safety_valve true
Suppress Parameter Validation: LDAP URL Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP URL parameter. false service_config_suppression_ldap.auth.url true
Suppress Parameter Validation: LDAP User DN Template Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP User DN Template parameter. false service_config_suppression_ldap.auth.user.dn.template true
Suppress Parameter Validation: Leader Imbalance Check Interval Whether to suppress configuration warnings produced by the built-in parameter validation for the Leader Imbalance Check Interval parameter. false service_config_suppression_leader.imbalance.check.interval.seconds true
Suppress Parameter Validation: Leader Imbalance Allowed Per Broker Whether to suppress configuration warnings produced by the built-in parameter validation for the Leader Imbalance Allowed Per Broker parameter. false service_config_suppression_leader.imbalance.per.broker.percentage true
Suppress Parameter Validation: Maximum Message Size Whether to suppress configuration warnings produced by the built-in parameter validation for the Maximum Message Size parameter. false service_config_suppression_message.max.bytes true
Suppress Parameter Validation: Minimum Number of Replicas in ISR Whether to suppress configuration warnings produced by the built-in parameter validation for the Minimum Number of Replicas in ISR parameter. false service_config_suppression_min.insync.replicas true
Suppress Parameter Validation: Default Number of Partitions Whether to suppress configuration warnings produced by the built-in parameter validation for the Default Number of Partitions parameter. false service_config_suppression_num.partitions true
Suppress Parameter Validation: Number of Replica Fetchers Whether to suppress configuration warnings produced by the built-in parameter validation for the Number of Replica Fetchers parameter. false service_config_suppression_num.replica.fetchers true
Suppress Parameter Validation: Offset Commit Topic Number of Partitions Whether to suppress configuration warnings produced by the built-in parameter validation for the Offset Commit Topic Number of Partitions parameter. false service_config_suppression_offsets.topic.num.partitions true
Suppress Parameter Validation: Offset Commit Topic Replication Factor Whether to suppress configuration warnings produced by the built-in parameter validation for the Offset Commit Topic Replication Factor parameter. false service_config_suppression_offsets.topic.replication.factor true
Suppress Parameter Validation: PAM Service Whether to suppress configuration warnings produced by the built-in parameter validation for the PAM Service parameter. false service_config_suppression_pam.auth.service 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 Kafka Plugin Hdfs Audit Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Kafka Plugin Hdfs Audit Directory parameter. false service_config_suppression_ranger_kafka_plugin_hdfs_audit_directory true
Suppress Parameter Validation: 'Ranger service' name for this Kafka service Whether to suppress configuration warnings produced by the built-in parameter validation for the 'Ranger service' name for this Kafka service parameter. false service_config_suppression_ranger_plugin_kafka_service_name true
Suppress Parameter Validation: Replica Maximum Fetch Size Whether to suppress configuration warnings produced by the built-in parameter validation for the Replica Maximum Fetch Size parameter. false service_config_suppression_replica.fetch.max.bytes true
Suppress Parameter Validation: Service Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter. false service_config_suppression_service_triggers true
Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter. false service_config_suppression_smon_derived_configs_safety_valve true
Suppress Parameter Validation: Transaction State Log Replication Factor Whether to suppress configuration warnings produced by the built-in parameter validation for the Transaction State Log Replication Factor parameter. false service_config_suppression_transaction.state.log.replication.factor true
Suppress Parameter Validation: ZooKeeper Root Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper Root parameter. false service_config_suppression_zookeeper.chroot true
Suppress Parameter Validation: ZooKeeper Session Timeout Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper Session Timeout parameter. false service_config_suppression_zookeeper.session.timeout.ms true
Suppress Health Test: Kafka Broker Health Whether to suppress the results of the Kafka Broker 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_kafka_kafka_broker_healthy true