Cruise Control Properties in Cloudera Runtime 7.2
Role groups:
Cruise Control Server
Categories:
Advanced
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Cruise Control Server Advanced Configuration Snippet (Safety Valve) for auth.credentials | For advanced use only. A string to be inserted into auth.credentials for this role only. |
auth.credentials_role_safety_valve
|
false | ||
| Cruise Control Server Advanced Configuration Snippet (Safety Valve) for capacity.json | For advanced use only. A string to be inserted into capacity.json for this role only. |
capacity.json_role_safety_valve
|
false | ||
| Cruise Control Server Environment Advanced Configuration Snippet (Safety Valve) | For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. |
CRUISE_CONTROL_SERVER_role_env_safety_valve
|
false | ||
| Cruise Control Server Advanced Configuration Snippet (Safety Valve) for cruisecontrol.properties | For advanced use only. A string to be inserted into cruisecontrol.properties for this role only. |
cruisecontrol.properties_role_safety_valve
|
false | ||
| Cruise Control Server 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 | |
| Cruise Control Server 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 |
|---|---|---|---|---|---|
| Cruise Control Server Log Directory | The log directory for log files of the role Cruise Control Server. |
log_dir
|
/var/log/cruisecontrol |
log_dir
|
false |
| Cruise Control Server Logging Threshold | The minimum log level for Cruise Control Server logs | INFO |
log_threshold
|
false | |
| Cruise Control Server Maximum Log File Backups | The maximum number of rolled log files to keep for Cruise Control Server logs. Typically used by log4j or logback. | 10 |
max_log_backup_index
|
false | |
| Cruise Control Server Max Log Size | The maximum size, in megabytes, per log file for Cruise Control Server logs. Typically used by log4j or logback. | 200 MiB |
max_log_size
|
false |
Monitoring
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| 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 % |
cruise_control_server_fd_thresholds
|
false | |
| Cruise Control Server Host Health Test | When computing the overall Cruise Control Server health, consider the host's health. | true |
cruise_control_server_host_health_enabled
|
false | |
| Cruise Control Server Process Health Test | Enables the health test that the Cruise Control Server's process state is consistent with the role configuration | true |
cruise_control_server_scm_health_enabled
|
false | |
| Enable Health Alerts for this Role | When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold | true |
enable_alerts
|
false | |
| Enable Configuration Change Alerts | When set, Cloudera Manager will send alerts when this entity's configuration changes. | false |
enable_config_alerts
|
false | |
| Log Directory Free Space Monitoring Absolute Thresholds | The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. | Warning: 10 GiB, Critical: 5 GiB |
log_directory_free_space_absolute_thresholds
|
false | |
| Log Directory Free Space Monitoring Percentage Thresholds | The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. | Warning: Never, Critical: Never |
log_directory_free_space_percentage_thresholds
|
false | |
| Metric Filter | Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
jvm_heap_used_mb metric:
{
"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": "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 |
|---|---|---|---|---|---|
| ADMIN Level Users | The list of ADMIN level users. |
auth_admins
|
auth_admins
|
false | |
| Authentication Method | Authentication method that Cruise Control uses to authenticate clients. |
auth_method
|
none |
auth_method
|
false |
| USER Level Users | The list of USER level users. |
auth_users
|
auth_users
|
false | |
| VIEWER Level Users | The list of VIEWER level users. |
auth_viewers
|
auth_viewers
|
false | |
| Broker Metrics Topic | The config for the Kafka sample store to save the model training samples. |
broker.metric.sample.store.topic
|
__KafkaCruiseControlModelTrainingSamples |
broker.metric.sample.store.topic
|
true |
| Broker Metrics Window Size | The broker metrics window size in milliseconds. |
broker.metrics.window.ms
|
5 minute(s) |
broker.metrics.window.ms
|
true |
| Default CPU Capacity | Default CPU capacity in capacity.json config. |
capacity.default.cpu
|
100 % |
capacity.default.cpu
|
true |
| Default Incoming Network Capacity | Default incoming network capacity in capacity.json config. |
capacity.default.network-in
|
100000 KiB |
capacity.default.network-in
|
true |
| Default Outgoing Network Capacity | Default outgoing network capacity in capacity.json config. |
capacity.default.network-out
|
100000 KiB |
capacity.default.network-out
|
true |
| Default Goals | The list of goals to optimize the Kafka cluster for with pre-computed proposals. |
default.goals
|
com.linkedin.kafka.cruisecontrol.analyzer.goals.RackAwareGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.ReplicaCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.DiskCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkInboundCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkOutboundCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.CpuCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.ReplicaDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.PotentialNwOutGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.DiskUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkInboundUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkOutboundUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.CpuUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.TopicReplicaDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.LeaderReplicaDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.LeaderBytesInDistributionGoal |
default.goals
|
true |
| Supported Goals | The list of supported goals. |
goals
|
com.linkedin.kafka.cruisecontrol.analyzer.goals.RackAwareGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.ReplicaCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.DiskCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkInboundCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkOutboundCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.CpuCapacityGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.ReplicaDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.PotentialNwOutGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.DiskUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkInboundUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.NetworkOutboundUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.CpuUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.TopicReplicaDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.LeaderReplicaDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.LeaderBytesInDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.goals.PreferredLeaderElectionGoal com.linkedin.kafka.cruisecontrol.analyzer.kafkaassigner.KafkaAssignerDiskUsageDistributionGoal com.linkedin.kafka.cruisecontrol.analyzer.kafkaassigner.KafkaAssignerEvenRackAwareGoal |
goals
|
true |
| Graceful Shutdown Timeout | The timeout in milliseconds to wait for graceful shutdown to complete. | 1 minute(s) |
graceful_stop_timeout
|
false | |
| Number of Broker Metric Windows | The total number of windows to keep for broker metric samples. |
num.broker.metrics.windows
|
1 |
num.broker.metrics.windows
|
true |
| Number of Metric Fetchers | The number of metric fetcher threads. |
num.metric.fetchers
|
1 |
num.metric.fetchers
|
true |
| Number of Partition Metric Windows | The total number of windows to keep for partition metric samples. |
num.partition.metrics.windows
|
1 |
num.partition.metrics.windows
|
true |
| Partition Metrics Topic | The config for the Kafka sample store to save the partition metric samples. |
partition.metric.sample.store.topic
|
__KafkaCruiseControlPartitionMetricSamples |
partition.metric.sample.store.topic
|
true |
| Partition Metrics Window Size | The partition metrics window size in milliseconds. |
partition.metrics.window.ms
|
5 minute(s) |
partition.metrics.window.ms
|
true |
| Kafka Client Security Protocol | Protocol to be used for communicating with Kafka. |
security.protocol
|
PLAINTEXT |
security.protocol
|
false |
| Trusted Proxy Authentication Service | The username part of the trusted proxy authentication service's principal. |
trusted_auth_service_user
|
knox |
trusted_auth_service_user
|
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 |
|---|---|---|---|---|---|
| Cruise Control Webserver Port | The endpoint of the REST interface. |
webserver.http.port
|
8899 |
webserver.http.port
|
true |
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 |
|---|---|---|---|---|---|
| Cruise Control Server TLS/SSL Client Trust Store File | The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Cruise Control Server might connect to. This is used when Cruise Control Server is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead. |
ssl.truststore.location
|
ssl_client_truststore_location
|
false | |
| Cruise Control Server TLS/SSL Client Trust Store Password | The password for the Cruise Control Server TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. |
ssl.truststore.password
|
ssl_client_truststore_password
|
false | |
| Enable TLS/SSL for Cruise Control Server | Encrypt communication between clients and Cruise Control Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). |
webserver.ssl.enable
|
false |
ssl_enabled
|
false |
| Cruise Control Server TLS/SSL Server JKS Keystore Key Password | The password that protects the private key contained in the JKS keystore used when Cruise Control Server is acting as a TLS/SSL server. |
webserver.ssl.key.password
|
ssl_server_keystore_keypassword
|
false | |
| Cruise Control Server TLS/SSL Server JKS Keystore File Location | The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Cruise Control Server is acting as a TLS/SSL server. The keystore must be in JKS format. |
webserver.ssl.keystore.location
|
ssl_server_keystore_location
|
false | |
| Cruise Control Server TLS/SSL Server JKS Keystore File Password | The password for the Cruise Control Server JKS keystore file. |
webserver.ssl.keystore.password
|
ssl_server_keystore_password
|
false |
Stacks Collection
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Stacks Collection Data Retention | The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. |
stacks_collection_data_retention
|
100 MiB |
stacks_collection_data_retention
|
false |
| Stacks Collection Directory | The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. |
stacks_collection_directory
|
stacks_collection_directory
|
false | |
| Stacks Collection Enabled | Whether or not periodic stacks collection is enabled. |
stacks_collection_enabled
|
false |
stacks_collection_enabled
|
true |
| Stacks Collection Frequency | The frequency with which stacks are collected. |
stacks_collection_frequency
|
5.0 second(s) |
stacks_collection_frequency
|
false |
| Stacks Collection Method | The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped. |
stacks_collection_method
|
jstack |
stacks_collection_method
|
false |
Suppressions
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Suppress Parameter Validation: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for auth.credentials | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server Advanced Configuration Snippet (Safety Valve) for auth.credentials parameter. | false |
role_config_suppression_auth.credentials_role_safety_valve
|
true | |
| Suppress Parameter Validation: ADMIN Level Users | Whether to suppress configuration warnings produced by the built-in parameter validation for the ADMIN Level Users parameter. | false |
role_config_suppression_auth_admins
|
true | |
| Suppress Parameter Validation: USER Level Users | Whether to suppress configuration warnings produced by the built-in parameter validation for the USER Level Users parameter. | false |
role_config_suppression_auth_users
|
true | |
| Suppress Parameter Validation: VIEWER Level Users | Whether to suppress configuration warnings produced by the built-in parameter validation for the VIEWER Level Users parameter. | false |
role_config_suppression_auth_viewers
|
true | |
| Suppress Parameter Validation: Broker Metrics Topic | Whether to suppress configuration warnings produced by the built-in parameter validation for the Broker Metrics Topic parameter. | false |
role_config_suppression_broker.metric.sample.store.topic
|
true | |
| Suppress Parameter Validation: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for capacity.json | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server Advanced Configuration Snippet (Safety Valve) for capacity.json parameter. | false |
role_config_suppression_capacity.json_role_safety_valve
|
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: Cruise Control Server Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server Environment Advanced Configuration Snippet (Safety Valve) parameter. | false |
role_config_suppression_cruise_control_server_role_env_safety_valve
|
true | |
| Suppress Parameter Validation: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for cruisecontrol.properties | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server Advanced Configuration Snippet (Safety Valve) for cruisecontrol.properties parameter. | false |
role_config_suppression_cruisecontrol.properties_role_safety_valve
|
true | |
| Suppress Parameter Validation: Default Goals | Whether to suppress configuration warnings produced by the built-in parameter validation for the Default Goals parameter. | false |
role_config_suppression_default.goals
|
true | |
| Suppress Parameter Validation: Supported Goals | Whether to suppress configuration warnings produced by the built-in parameter validation for the Supported Goals parameter. | false |
role_config_suppression_goals
|
true | |
| Suppress Parameter Validation: Cruise Control Server Logging Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server Logging Advanced Configuration Snippet (Safety Valve) parameter. | false |
role_config_suppression_log4j_safety_valve
|
true | |
| Suppress Parameter Validation: Cruise Control Server Log Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server Log Directory parameter. | false |
role_config_suppression_log_dir
|
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: Partition Metrics Topic | Whether to suppress configuration warnings produced by the built-in parameter validation for the Partition Metrics Topic parameter. | false |
role_config_suppression_partition.metric.sample.store.topic
|
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: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for ssl.properties | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server Advanced Configuration Snippet (Safety Valve) for ssl.properties parameter. | false |
role_config_suppression_ssl.properties_role_safety_valve
|
true | |
| Suppress Parameter Validation: Cruise Control Server TLS/SSL Client Trust Store File | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server TLS/SSL Client Trust Store File parameter. | false |
role_config_suppression_ssl_client_truststore_location
|
true | |
| Suppress Parameter Validation: Cruise Control Server TLS/SSL Client Trust Store Password | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server TLS/SSL Client Trust Store Password parameter. | false |
role_config_suppression_ssl_client_truststore_password
|
true | |
| Suppress Parameter Validation: Cruise Control Server TLS/SSL Server JKS Keystore Key Password | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server TLS/SSL Server JKS Keystore Key Password parameter. | false |
role_config_suppression_ssl_server_keystore_keypassword
|
true | |
| Suppress Parameter Validation: Cruise Control Server TLS/SSL Server JKS Keystore File Location | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server TLS/SSL Server JKS Keystore File Location parameter. | false |
role_config_suppression_ssl_server_keystore_location
|
true | |
| Suppress Parameter Validation: Cruise Control Server TLS/SSL Server JKS Keystore File Password | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Server TLS/SSL Server JKS Keystore File Password parameter. | false |
role_config_suppression_ssl_server_keystore_password
|
true | |
| Suppress Parameter Validation: Stacks Collection Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. | false |
role_config_suppression_stacks_collection_directory
|
true | |
| Suppress Parameter Validation: Trusted Proxy Authentication Service | Whether to suppress configuration warnings produced by the built-in parameter validation for the Trusted Proxy Authentication Service parameter. | false |
role_config_suppression_trusted_auth_service_user
|
true | |
| Suppress Parameter Validation: Cruise Control Webserver Port | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Webserver Port parameter. | false |
role_config_suppression_webserver.http.port
|
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_cruise_control_cruise_control_server_audit_health
|
true | |
| Suppress Health Test: File Descriptors | Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_cruise_control_cruise_control_server_file_descriptor
|
true | |
| Suppress Health Test: Host Health | Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_cruise_control_cruise_control_server_host_health
|
true | |
| Suppress Health Test: Log Directory Free Space | Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_cruise_control_cruise_control_server_log_directory_free_space
|
true | |
| Suppress Health Test: Process Status | Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_cruise_control_cruise_control_server_scm_health
|
true | |
| Suppress Health Test: Swap Memory Usage | Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_cruise_control_cruise_control_server_swap_memory_usage
|
true | |
| Suppress Health Test: Unexpected Exits | Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_cruise_control_cruise_control_server_unexpected_exits
|
true |
Service-Wide
Categories:
Advanced
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Cruise Control 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. |
CRUISE_CONTROL_service_env_safety_valve
|
false | ||
| System Group | The group that this service's processes should run as. | hadoop |
process_groupname
|
true | |
| System User | The user that this service's processes should run as. | cruisecontrol |
process_username
|
true |
Monitoring
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Cruise Control Server Role Health Test | When computing the overall CRUISE_CONTROL health, consider Cruise Control Server's health | true |
CRUISE_CONTROL_CRUISE_CONTROL_SERVER_health_enabled
|
false | |
| Enable Service Level Health Alerts | When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold | true |
enable_alerts
|
false | |
| Enable Configuration Change Alerts | When set, Cloudera Manager will send alerts when this entity's configuration changes. | false |
enable_config_alerts
|
false | |
| Service Triggers | The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
[{"triggerName": "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 |
|---|---|---|---|---|---|
| KAFKA Service | Name of the KAFKA service that this Cruise Control service instance depends on |
kafka_service
|
true | ||
| ZooKeeper Service | Name of the ZooKeeper service that this Cruise Control service instance depends on |
zookeeper_service
|
true |
Suppressions
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Suppress Configuration Validator: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for auth.credentials | Whether to suppress configuration warnings produced by the Cruise Control Server Advanced Configuration Snippet (Safety Valve) for auth.credentials configuration validator. | false |
role_config_suppression_auth.credentials_role_safety_valve
|
true | |
| Suppress Configuration Validator: ADMIN Level Users | Whether to suppress configuration warnings produced by the ADMIN Level Users configuration validator. | false |
role_config_suppression_auth_admins
|
true | |
| Suppress Configuration Validator: USER Level Users | Whether to suppress configuration warnings produced by the USER Level Users configuration validator. | false |
role_config_suppression_auth_users
|
true | |
| Suppress Configuration Validator: VIEWER Level Users | Whether to suppress configuration warnings produced by the VIEWER Level Users configuration validator. | false |
role_config_suppression_auth_viewers
|
true | |
| Suppress Configuration Validator: Broker Metrics Topic | Whether to suppress configuration warnings produced by the Broker Metrics Topic configuration validator. | false |
role_config_suppression_broker.metric.sample.store.topic
|
true | |
| Suppress Configuration Validator: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for capacity.json | Whether to suppress configuration warnings produced by the Cruise Control Server Advanced Configuration Snippet (Safety Valve) for capacity.json configuration validator. | false |
role_config_suppression_capacity.json_role_safety_valve
|
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: Cruise Control Server Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the Cruise Control Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator. | false |
role_config_suppression_cruise_control_server_role_env_safety_valve
|
true | |
| Suppress Configuration Validator: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for cruisecontrol.properties | Whether to suppress configuration warnings produced by the Cruise Control Server Advanced Configuration Snippet (Safety Valve) for cruisecontrol.properties configuration validator. | false |
role_config_suppression_cruisecontrol.properties_role_safety_valve
|
true | |
| Suppress Configuration Validator: Default Goals | Whether to suppress configuration warnings produced by the Default Goals configuration validator. | false |
role_config_suppression_default.goals
|
true | |
| Suppress Configuration Validator: Supported Goals | Whether to suppress configuration warnings produced by the Supported Goals configuration validator. | false |
role_config_suppression_goals
|
true | |
| Suppress Configuration Validator: Cruise Control Server Logging Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the Cruise Control Server Logging Advanced Configuration Snippet (Safety Valve) configuration validator. | false |
role_config_suppression_log4j_safety_valve
|
true | |
| Suppress Configuration Validator: Cruise Control Server Log Directory | Whether to suppress configuration warnings produced by the Cruise Control Server Log Directory configuration validator. | false |
role_config_suppression_log_dir
|
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: Partition Metrics Topic | Whether to suppress configuration warnings produced by the Partition Metrics Topic configuration validator. | false |
role_config_suppression_partition.metric.sample.store.topic
|
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: Cruise Control Server Advanced Configuration Snippet (Safety Valve) for ssl.properties | Whether to suppress configuration warnings produced by the Cruise Control Server Advanced Configuration Snippet (Safety Valve) for ssl.properties configuration validator. | false |
role_config_suppression_ssl.properties_role_safety_valve
|
true | |
| Suppress Configuration Validator: Cruise Control Server TLS/SSL Client Trust Store File | Whether to suppress configuration warnings produced by the Cruise Control Server TLS/SSL Client Trust Store File configuration validator. | false |
role_config_suppression_ssl_client_truststore_location
|
true | |
| Suppress Configuration Validator: Cruise Control Server TLS/SSL Client Trust Store Password | Whether to suppress configuration warnings produced by the Cruise Control Server TLS/SSL Client Trust Store Password configuration validator. | false |
role_config_suppression_ssl_client_truststore_password
|
true | |
| Suppress Configuration Validator: Cruise Control Server TLS/SSL Server JKS Keystore Key Password | Whether to suppress configuration warnings produced by the Cruise Control Server TLS/SSL Server JKS Keystore Key Password configuration validator. | false |
role_config_suppression_ssl_server_keystore_keypassword
|
true | |
| Suppress Configuration Validator: Cruise Control Server TLS/SSL Server JKS Keystore File Location | Whether to suppress configuration warnings produced by the Cruise Control Server TLS/SSL Server JKS Keystore File Location configuration validator. | false |
role_config_suppression_ssl_server_keystore_location
|
true | |
| Suppress Configuration Validator: Cruise Control Server TLS/SSL Server JKS Keystore File Password | Whether to suppress configuration warnings produced by the Cruise Control Server 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: Trusted Proxy Authentication Service | Whether to suppress configuration warnings produced by the Trusted Proxy Authentication Service configuration validator. | false |
role_config_suppression_trusted_auth_service_user
|
true | |
| Suppress Configuration Validator: Cruise Control Webserver Port | Whether to suppress configuration warnings produced by the Cruise Control Webserver Port configuration validator. | false |
role_config_suppression_webserver.http.port
|
true | |
| Suppress Configuration Validator: Cruise Control Server Count Validator | Whether to suppress configuration warnings produced by the Cruise Control Server Count Validator configuration validator. | false |
service_config_suppression_cruise_control_server_count_validator
|
true | |
| Suppress Parameter Validation: Cruise Control Service Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Cruise Control Service Environment Advanced Configuration Snippet (Safety Valve) parameter. | false |
service_config_suppression_cruise_control_service_env_safety_valve
|
true | |
| Suppress Parameter Validation: System Group | Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter. | false |
service_config_suppression_process_groupname
|
true | |
| Suppress Parameter Validation: System User | Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter. | false |
service_config_suppression_process_username
|
true | |
| Suppress Parameter Validation: 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 Health Test: Cruise Control Server Health | Whether to suppress the results of the Cruise Control Server Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
service_health_suppression_cruise_control_cruise_control_cruise_control_server_health
|
true |
