Kudu Properties in Cloudera Runtime 7.1.7

Role groups:

Master

Advanced

Master Advanced Configuration Snippet (Safety Valve) for gflagfile

Description: For advanced use only. A string to be inserted into gflagfile for this role only.
Related Name
Default Value
API Name: gflagfile_role_safety_valve
Required: false

Master Advanced Configuration Snippet (Safety Valve) for kudu-monitoring.properties

Description: For advanced use only. A string to be inserted into kudu-monitoring.properties for this role only.
Related Name
Default Value
API Name: kudu-monitoring.properties_role_safety_valve
Required: false

Master Environment Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration.
Related Name
Default Value
API Name: KUDU_MASTER_role_env_safety_valve
Required: false

Enable auto refresh for metric configurations

Description: When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value: false
API Name: metric_config_auto_refresh
Required: false

Automatically Restart Process

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

Enable Metric Collection

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

Process Start Retry Attempts

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

Process Start Wait Timeout

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

Logs

Master Maximum Log Level to Buffer

Description: Log messages logged at this level or lower are buffered in memory.
Related Name: logbuflevel
Default Value: 0
API Name: glog_logbuflevel
Required: false

Master Maximum Log Size

Description: Approximate maximum log file size in megabytes before rolling to a new log file.
Related Name: max_log_size
Default Value: 1800 MiB
API Name: glog_maxlogsize
Required: false

Master Minimum Log Level

Description: Messages logged via LOG() at a lower level than this are not logged anywhere.
Related Name: minloglevel
Default Value: 0
API Name: glog_minloglevel
Required: false

Master Minimum Log Verbosity

Description: Messages logged via VLOG() at a lower verbosity than this are not logged anywhere.
Related Name: v
Default Value: 0
API Name: glog_verbose
Required: false

Master Log Directory

Description: The log directory for log files of the role Master.
Related Name: log_dir
Default Value: /var/log/kudu
API Name: log_dir
Required: false

Monitoring

Enable Health Alerts for this Role

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

Enable Configuration Change Alerts

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

Enable Failed Data Directories

Description: Enables or disables the health test. When disabled, the test does not run at all, nor generate health history.
Related Name
Default Value: true
API Name: KUDU-KUDU_MASTER-7.1.0-FAILED_DATA_DIRS_test_enable
Required: false

Enable Full Data Directories

Description: Enables or disables the health test. When disabled, the test does not run at all, nor generate health history.
Related Name
Default Value: true
API Name: KUDU-KUDU_MASTER-7.1.0-FULL_DATA_DIRS_test_enable
Required: false

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value: Warning: 50.0 %, Critical: 70.0 %
API Name: kudu_master_fd_thresholds
Required: false

Master Host Health Test

Description: When computing the overall Master health, consider the host's health.
Related Name
Default Value: true
API Name: kudu_master_host_health_enabled
Required: false

Master Process Health Test

Description: Enables the health test that the Master's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: kudu_master_scm_health_enabled
Required: false

Log Directory Free Space Monitoring Absolute Thresholds

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

Log Directory Free Space Monitoring Percentage Thresholds

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

Metric Filter

Description

Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:

Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
Metric Name - The name of a metric that will be included or excluded during metric collection.

If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:

Include only Health Test Metric Set: Selected.
Include/Exclude Custom Metrics: Set to Include.
Metric Name: jvm_heap_used_mb

You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:

{
  "includeHealthTestMetricSet": true, 
  "filterType": "whitelist",
  "metrics": ["jvm_heap_used_mb"]
}

Related Name

Default Value

API Name

monitoring_metric_filter

Required

false

Swap Memory Usage Rate Thresholds

Description: The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_swap_memory_rate_thresholds
Required: false

Swap Memory Usage Rate Window

Description: The period to review when computing unexpected swap memory usage change of the process.
Related Name: common.process.swap_memory_rate_window
Default Value: 5 minute(s)
API Name: process_swap_memory_rate_window
Required: false

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value: Warning: 200 B, Critical: Never
API Name: process_swap_memory_thresholds
Required: false

Role Triggers

Description

The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:

triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
triggerExpression (mandatory) - A tsquery expression representing the trigger.
streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.

For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:

[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad",
  "streamThreshold": 0, "enabled": "true"}]

See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.

Related Name

Default Value

[]

API Name

role_triggers

Required

true

Unexpected Exits Thresholds

Description: The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: unexpected_exits_thresholds
Required: false

Unexpected Exits Monitoring Period

Description: The period to review when computing unexpected exits.
Related Name
Default Value: 5 minute(s)
API Name: unexpected_exits_window
Required: false

Other

Master Diagnostics Collection Timeout

Description: The timeout in milliseconds to wait for diagnostics collection to complete.
Related Name
Default Value: 1 minute(s)
API Name: csd_role_diagnostics_timeout
Required: false

Default Number of Replicas

Description: Default number of replicas for each tablet.
Related Name: default_num_replicas
Default Value: 3
API Name: default_num_replicas
Required: true

Kudu Master Data Directories

Description: Directories where Kudu masters will store data blocks.
Related Name: fs_data_dirs
Default Value
API Name: fs_data_dirs
Required: true

Kudu Master WAL Directory

Description: Directory where Kudu masters will store write-ahead logs. It can be the same as one of the data directories, but not a sub-directory of a data directory. Master and tablet servers must use different directories when co-located on the same machine.
Related Name: fs_wal_dir
Default Value
API Name: fs_wal_dir
Required: true

Kudu Master WAL Fsyncs All Entries

Description: If true, the Master will use the fsync system call to ensure that all modifications to the catalog table are durably written to disk. WARNING: In this release, enabling this option can cause serious issues.
Related Name: log_force_fsync_all
Default Value: false
API Name: log_force_fsync_all
Required: true

Master Address

Description: Configuration that's automatically set by Cloudera Manager to propagate the Master's address to the Tablet Servers.
Related Name: server.address
Default Value
API Name: master_address
Required: false

Kudu Master Core Dump Directory

Description: If Enable Core Dump is set, Kudu masters will dump cores to this location.
Related Name: master_core_dump_directory
Default Value: /var/log/kudu
API Name: master_core_dump_directory
Required: true

Kudu Metrics URL Parameters

Description: The URL query parameters to append to the `/metrics` URL when collecting Kudu metrics.
Related Name: metrics_url_parameters
Default Value: compact=1&level=info
API Name: metrics_url_parameters
Required: true

Kudu Master Web UI Interface

Description: The interface of the Kudu Master Web UI. If blank, binds to 0.0.0.0.
Related Name: webserver_interface
Default Value
API Name: webserver_interface
Required: false

Performance

Maximum Process File Descriptors

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

Ports and Addresses

Kudu Master Web UI Port

Description: The port of the Kudu Master Web UI.
Related Name: webserver_port
Default Value: 8051
API Name: webserver_port
Required: true

Resource Management

Cgroup CPU Shares

Description: Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager.
Related Name: cpu.shares
Default Value: 1024
API Name: rm_cpu_shares
Required: true

Custom Control Group Resources (overrides Cgroup settings)

Description: Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
Related Name: custom.cgroups
Default Value
API Name: rm_custom_resources
Required: false

Cgroup I/O Weight

Description: Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager.
Related Name: blkio.weight
Default Value: 500
API Name: rm_io_weight
Required: true

Cgroup Memory Hard Limit

Description: Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_hard_limit
Required: true

Cgroup Memory Soft Limit

Description: Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.soft_limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_soft_limit
Required: true

Security

Enable TLS/SSL for Master

Description: Encrypt communication between clients and Master using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name: ssl_enabled
Default Value: false
API Name: ssl_enabled
Required: false

Master TLS/SSL Server CA Certificate (PEM Format)

Description: The path to the TLS/SSL file containing the certificate of the certificate authority (CA) and any intermediate certificates used to sign the server certificate. Used when Master is acting as a TLS/SSL server. The certificate file must be in PEM format, and is usually created by concatenating all of the appropriate root and intermediate certificates.
Related Name
Default Value
API Name: ssl_server_ca_certificate_location
Required: false

Master TLS/SSL Server Certificate File (PEM Format)

Description: The path to the TLS/SSL file containing the server certificate key used for TLS/SSL. Used when Master is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name: webserver_certificate_file
Default Value
API Name: ssl_server_certificate_location
Required: false

Master TLS/SSL Server Private Key File (PEM Format)

Description: The path to the TLS/SSL file containing the private key used for TLS/SSL. Used when Master is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name: webserver_private_key_file
Default Value
API Name: ssl_server_privatekey_location
Required: false

Master TLS/SSL Private Key Password

Description: The password for the private key in the Master TLS/SSL Server Certificate and Private Key file. If left blank, the private key is not protected by a password.
Related Name: webserver_private_key_password_cmd
Default Value
API Name: ssl_server_privatekey_password
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: Default Number of Replicas

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Default Number of Replicas parameter.
Related Name
Default Value: false
API Name: role_config_suppression_default_num_replicas
Required: true

Suppress Parameter Validation: Kudu Master Data Directories

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Master Data Directories parameter.
Related Name
Default Value: false
API Name: role_config_suppression_fs_data_dirs
Required: true

Suppress Parameter Validation: Kudu Master WAL Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Master WAL Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_fs_wal_dir
Required: true

Suppress Parameter Validation: Master Advanced Configuration Snippet (Safety Valve) for gflagfile

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Master Advanced Configuration Snippet (Safety Valve) for gflagfile parameter.
Related Name
Default Value: false
API Name: role_config_suppression_gflagfile_role_safety_valve
Required: true

Suppress Parameter Validation: Master Advanced Configuration Snippet (Safety Valve) for kudu-monitoring.properties

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Master Advanced Configuration Snippet (Safety Valve) for kudu-monitoring.properties parameter.
Related Name
Default Value: false
API Name: role_config_suppression_kudu-monitoring.properties_role_safety_valve
Required: true

Suppress Parameter Validation: Master Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: Master Log Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Master Log Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log_dir
Required: true

Suppress Parameter Validation: Master Address

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

Suppress Parameter Validation: Kudu Master Core Dump Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Master Core Dump Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_master_core_dump_directory
Required: true

Suppress Parameter Validation: Kudu Metrics URL Parameters

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Metrics URL Parameters parameter.
Related Name
Default Value: false
API Name: role_config_suppression_metrics_url_parameters
Required: true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Parameter Validation: Role Triggers

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

Suppress Parameter Validation: Master TLS/SSL Server CA Certificate (PEM Format)

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

Suppress Parameter Validation: Master TLS/SSL Server Certificate File (PEM Format)

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

Suppress Parameter Validation: Master TLS/SSL Server Private Key File (PEM Format)

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

Suppress Parameter Validation: Master TLS/SSL Private Key Password

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

Suppress Parameter Validation: Kudu Master Web UI Interface

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Master Web UI Interface parameter.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_interface
Required: true

Suppress Parameter Validation: Kudu Master Web UI Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Master Web UI Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_port
Required: true

Suppress Health Test: Failed Data Directories

Description: Whether to suppress the results of the Failed Data Directories heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu-kudu_master-7.1.0-failed_data_dirs
Required: true

Suppress Health Test: Full Data Directories

Description: Whether to suppress the results of the Full Data Directories heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu-kudu_master-7.1.0-full_data_dirs
Required: true

Suppress Health Test: Audit Pipeline Test

Description: Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_master_audit_health
Required: true

Suppress Health Test: File Descriptors

Description: Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_master_file_descriptor
Required: true

Suppress Health Test: Host Health

Description: Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_master_host_health
Required: true

Suppress Health Test: Log Directory Free Space

Description: Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_master_log_directory_free_space
Required: true

Suppress Health Test: Process Status

Description: Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_master_scm_health
Required: true

Suppress Health Test: Swap Memory Usage

Description: Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_master_swap_memory_usage
Required: true

Suppress Health Test: Swap Memory Usage Rate Beta

Description: Whether to suppress the results of the Swap Memory Usage Rate Beta heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_master_swap_memory_usage_rate
Required: true

Suppress Health Test: Unexpected Exits

Description: Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_master_unexpected_exits
Required: true

Service-Wide

Advanced

Kudu Service Advanced Configuration Snippet (Safety Valve) for gflagfile

Description: For advanced use only, a string to be inserted into gflagfile. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: gflagfile_service_safety_valve
Required: false

Kudu Service Advanced Configuration Snippet (Safety Valve) for kudu-monitoring.properties

Description: For advanced use only, a string to be inserted into kudu-monitoring.properties. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: kudu-monitoring.properties_service_safety_valve
Required: false

Kudu Service Environment Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: KUDU_service_env_safety_valve
Required: false

System Group

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

System User

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

Monitoring

Enable Service Level Health Alerts

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

Enable Configuration Change Alerts

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

Healthy Master Monitoring Thresholds

Description: The health test thresholds of the overall Master health. The check returns "Concerning" health if the percentage of "Healthy" Masters falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Masters falls below the critical threshold.
Related Name
Default Value: Warning: 80.1 %, Critical: 60.0 %
API Name: KUDU_KUDU_MASTER_healthy_thresholds
Required: false

Healthy Tablet Server Monitoring Thresholds

Description: The health test thresholds of the overall Tablet Server health. The check returns "Concerning" health if the percentage of "Healthy" Tablet Servers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Tablet Servers falls below the critical threshold.
Related Name
Default Value: Warning: 75.0 %, Critical: 50.0 %
API Name: KUDU_KUDU_TSERVER_healthy_thresholds
Required: false

Service Triggers

Description

The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:

triggerName (mandatory) - The name of the trigger. This value must be unique for the specific service.
triggerExpression (mandatory) - A tsquery expression representing the trigger.
streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.

For example, the following JSON formatted trigger fires if there are more than 10 DataNodes with more than 500 file descriptors opened:

[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad",
  "streamThreshold": 10, "enabled": "true"}]

Related Name

Default Value

[]

API Name

service_triggers

Required

true

Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones.
Related Name
Default Value
API Name: smon_derived_configs_safety_valve
Required: false

Other

Enable Core Dump

Description: Used to generate a core dump to get more information about a Kudu crash. Unless otherwise configured systemwide using /proc/sys/kernel/core_pattern, the dump is generated in the configured core dump directory. The core file can be very large.
Related Name: enable_core_dump
Default Value: false
API Name: enable_core_dump
Required: true

Enable Secure Authentication, Encryption, And Web UI

Description: Enable secure authentication and encryption between all Kudu clients and servers as well as between individual servers. Also enables secure authentication in every Kudu server's web UI. Kerberos must be configured.
Related Name: enable_security
Default Value: false
API Name: enable_security
Required: true

Maximum Number of Per-tablet-server Replica Moves

Description: Maximum number of replica moves to perform concurrently on one tablet server: moves of replicas to the server and moves of replicas off of the server count against this limit.
Related Name: rb_max_moves_per_server
Default Value: 5
API Name: rb_max_moves_per_server
Required: false

Maximum Allowed Runtime of the Rebalancing Tool

Description: Maximum time to run the rebalancing, in seconds. Specifying 0 means not imposing any limit on the rebalancing run time.
Related Name: rb_max_run_time_sec
Default Value: 0
API Name: rb_max_run_time_sec
Required: false

Maximum Allowed Duration Without Rebalancer Progress

Description: Maximum duration of the 'staleness' interval where the rebalance can not make progress. If this period elapses without the rebalancer making progress, it will exit indicating failure. This may happen in case of a persistent problem with the cluster or when some unexpected concurrent activity is present (such as automatic recovery of failed replicas, etc.)
Related Name: rb_max_staleness_interval_sec
Default Value: 300
API Name: rb_max_staleness_interval_sec
Required: false

Maximum Allowed Runtime to Rolling Restart a Batch of Servers

Description: Maximum time to allow for the restart of a batch of servers during a rolling restart. If this period elapses without the cluster becoming healthy, the rolling restart will exit indicating failure. This may happen if there is a persistent problem with the cluster.
Related Name: rr_batch_time_limit_sec
Default Value: 1800
API Name: rr_batch_time_limit_sec
Required: false

Rolling Restart Health Check Interval

Description: Interval in seconds with which to check the health of a cluster in waiting for a server or batch of servers to come back online, before moving onto the next server or batch of servers during a rolling restart.
Related Name: rr_health_check_interval_sec
Default Value: 60
API Name: rr_health_check_interval_sec
Required: false

Sentry Service

Description: Name of the Sentry service that this Kudu service instance depends on
Related Name
Default Value
API Name: sentry_service
Required: false

Superuser Access Control List

Description: The list of usernames to allow as super users, comma-separated. A '*' entry indicates that all authenticated users are allowed. If this is left unset or blank, the default behavior is that the identity of the daemon itself determines the superuser. If the daemon is logged in from a Keytab, then the local username from the Kerberos principal is used; otherwise, the local Unix username is used.
Related Name: superuser_acl
Default Value
API Name: superuser_acl
Required: false

User Access Control List

Description: The list of usernames who may access the cluster, comma-separated. A '*' entry indicates that all authenticated users are allowed.
Related Name: user_acl
Default Value: *
API Name: user_acl
Required: false

Security

Kerberos Principal

Description: Kerberos principal short name used by all roles of this service.
Related Name
Default Value: kudu
API Name: kerberos_princ_name
Required: true

Suppressions

Suppress Configuration Validator: Kudu Tablet Server Block Cache Capacity

Description: Whether to suppress configuration warnings produced by the Kudu Tablet Server Block Cache Capacity configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_block_cache_capacity_mb
Required: true

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Configuration Validator: Default Number of Replicas

Description: Whether to suppress configuration warnings produced by the Default Number of Replicas configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_default_num_replicas
Required: true

Suppress Configuration Validator: Kudu Master Data Directories

Description: Whether to suppress configuration warnings produced by the Kudu Master Data Directories configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_fs_data_dirs
Required: true

Suppress Configuration Validator: Kudu Master WAL Directory

Description: Whether to suppress configuration warnings produced by the Kudu Master WAL Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_fs_wal_dir
Required: true

Suppress Configuration Validator: Master Advanced Configuration Snippet (Safety Valve) for gflagfile

Description: Whether to suppress configuration warnings produced by the Master Advanced Configuration Snippet (Safety Valve) for gflagfile configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_gflagfile_role_safety_valve
Required: true

Suppress Configuration Validator: Master Advanced Configuration Snippet (Safety Valve) for kudu-monitoring.properties

Description: Whether to suppress configuration warnings produced by the Master Advanced Configuration Snippet (Safety Valve) for kudu-monitoring.properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_kudu-monitoring.properties_role_safety_valve
Required: true

Suppress Configuration Validator: Master Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Master Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_kudu_master_role_env_safety_valve
Required: true

Suppress Configuration Validator: Tablet Server Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Tablet Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_kudu_tserver_role_env_safety_valve
Required: true

Suppress Configuration Validator: Master Log Directory

Description: Whether to suppress configuration warnings produced by the Master Log Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_log_dir
Required: true

Suppress Configuration Validator: Kudu Tablet Server Maintenance Threads

Description: Whether to suppress configuration warnings produced by the Kudu Tablet Server Maintenance Threads configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_maintenance_manager_num_threads
Required: true

Suppress Configuration Validator: Master Address

Description: Whether to suppress configuration warnings produced by the Master Address configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_master_address
Required: true

Suppress Configuration Validator: Kudu Master Core Dump Directory

Description: Whether to suppress configuration warnings produced by the Kudu Master Core Dump Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_master_core_dump_directory
Required: true

Suppress Configuration Validator: Kudu Tablet Server Hard Memory Limit

Description: Whether to suppress configuration warnings produced by the Kudu Tablet Server Hard Memory Limit configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_memory_limit_hard_bytes
Required: true

Suppress Configuration Validator: Kudu Metrics URL Parameters

Description: Whether to suppress configuration warnings produced by the Kudu Metrics URL Parameters configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_metrics_url_parameters
Required: true

Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Configuration Validator: Role Triggers

Description: Whether to suppress configuration warnings produced by the Role Triggers configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Configuration Validator: Master TLS/SSL Server CA Certificate (PEM Format)

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

Suppress Configuration Validator: Master TLS/SSL Server Certificate File (PEM Format)

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

Suppress Configuration Validator: Master TLS/SSL Server Private Key File (PEM Format)

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

Suppress Configuration Validator: Master TLS/SSL Private Key Password

Description: Whether to suppress configuration warnings produced by the Master TLS/SSL Private Key Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_privatekey_password
Required: true

Suppress Configuration Validator: Kudu Tablet Server Core Dump Directory

Description: Whether to suppress configuration warnings produced by the Kudu Tablet Server Core Dump Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_tserver_core_dump_directory
Required: true

Suppress Configuration Validator: Kudu Master Web UI Interface

Description: Whether to suppress configuration warnings produced by the Kudu Master Web UI Interface configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_interface
Required: true

Suppress Configuration Validator: Kudu Master Web UI Port

Description: Whether to suppress configuration warnings produced by the Kudu Master Web UI Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_port
Required: true

Suppress Parameter Validation: Kudu Service Advanced Configuration Snippet (Safety Valve) for gflagfile

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Service Advanced Configuration Snippet (Safety Valve) for gflagfile parameter.
Related Name
Default Value: false
API Name: service_config_suppression_gflagfile_service_safety_valve
Required: true

Suppress Parameter Validation: Kerberos Principal

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

Suppress Parameter Validation: Kudu Service Advanced Configuration Snippet (Safety Valve) for kudu-monitoring.properties

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Service Advanced Configuration Snippet (Safety Valve) for kudu-monitoring.properties parameter.
Related Name
Default Value: false
API Name: service_config_suppression_kudu-monitoring.properties_service_safety_valve
Required: true

Suppress Configuration Validator: Master Count Validator

Description: Whether to suppress configuration warnings produced by the Master Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_kudu_master_count_validator
Required: true

Suppress Parameter Validation: Kudu Service Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Configuration Validator: Tablet Server Count Validator

Description: Whether to suppress configuration warnings produced by the Tablet Server Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_kudu_tserver_count_validator
Required: true

Suppress Parameter Validation: System Group

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

Suppress Parameter Validation: System User

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

Suppress Parameter Validation: Service Triggers

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

Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: service_config_suppression_smon_derived_configs_safety_valve
Required: true

Suppress Parameter Validation: Superuser Access Control List

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Superuser Access Control List parameter.
Related Name
Default Value: false
API Name: service_config_suppression_superuser_acl
Required: true

Suppress Parameter Validation: User Access Control List

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the User Access Control List parameter.
Related Name
Default Value: false
API Name: service_config_suppression_user_acl
Required: true

Suppress Health Test: Master Health

Description: Whether to suppress the results of the Master Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: service_health_suppression_kudu_kudu_master_healthy
Required: true

Suppress Health Test: Tablet Server Health

Description: Whether to suppress the results of the Tablet Server Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: service_health_suppression_kudu_kudu_tserver_healthy
Required: true

Tablet Server

Advanced

Tablet Server Advanced Configuration Snippet (Safety Valve) for gflagfile

Description: For advanced use only. A string to be inserted into gflagfile for this role only.
Related Name
Default Value
API Name: gflagfile_role_safety_valve
Required: false

Tablet Server Advanced Configuration Snippet (Safety Valve) for kudu-monitoring.properties

Description: For advanced use only. A string to be inserted into kudu-monitoring.properties for this role only.
Related Name
Default Value
API Name: kudu-monitoring.properties_role_safety_valve
Required: false

Tablet Server Environment Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration.
Related Name
Default Value
API Name: KUDU_TSERVER_role_env_safety_valve
Required: false

Enable auto refresh for metric configurations

Description: When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value: false
API Name: metric_config_auto_refresh
Required: false

Automatically Restart Process

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

Enable Metric Collection

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

Process Start Retry Attempts

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

Process Start Wait Timeout

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

Logs

Tablet Server Maximum Log Level to Buffer

Description: Log messages logged at this level or lower are buffered in memory.
Related Name: logbuflevel
Default Value: 0
API Name: glog_logbuflevel
Required: false

Tablet Server Maximum Log Size

Description: Approximate maximum log file size in megabytes before rolling to a new log file.
Related Name: max_log_size
Default Value: 1800 MiB
API Name: glog_maxlogsize
Required: false

Tablet Server Minimum Log Level

Description: Messages logged via LOG() at a lower level than this are not logged anywhere.
Related Name: minloglevel
Default Value: 0
API Name: glog_minloglevel
Required: false

Tablet Server Minimum Log Verbosity

Description: Messages logged via VLOG() at a lower verbosity than this are not logged anywhere.
Related Name: v
Default Value: 0
API Name: glog_verbose
Required: false

Tablet Server Log Directory

Description: The log directory for log files of the role Tablet Server.
Related Name: log_dir
Default Value: /var/log/kudu
API Name: log_dir
Required: false

Monitoring

Enable Health Alerts for this Role

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

Enable Configuration Change Alerts

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

Enable Failed Data Directories

Description: Enables or disables the health test. When disabled, the test does not run at all, nor generate health history.
Related Name
Default Value: true
API Name: KUDU-KUDU_TSERVER-7.1.0-FAILED_DATA_DIRS_test_enable
Required: false

Enable Full Data Directories

Description: Enables or disables the health test. When disabled, the test does not run at all, nor generate health history.
Related Name
Default Value: true
API Name: KUDU-KUDU_TSERVER-7.1.0-FULL_DATA_DIRS_test_enable
Required: false

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value: Warning: 50.0 %, Critical: 70.0 %
API Name: kudu_tserver_fd_thresholds
Required: false

Tablet Server Host Health Test

Description: When computing the overall Tablet Server health, consider the host's health.
Related Name
Default Value: true
API Name: kudu_tserver_host_health_enabled
Required: false

Tablet Server Process Health Test

Description: Enables the health test that the Tablet Server's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: kudu_tserver_scm_health_enabled
Required: false

Log Directory Free Space Monitoring Absolute Thresholds

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

Log Directory Free Space Monitoring Percentage Thresholds

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

Metric Filter

Description

Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:

Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
Metric Name - The name of a metric that will be included or excluded during metric collection.

Include only Health Test Metric Set: Selected.
Include/Exclude Custom Metrics: Set to Include.
Metric Name: jvm_heap_used_mb

You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:

{
  "includeHealthTestMetricSet": true, 
  "filterType": "whitelist",
  "metrics": ["jvm_heap_used_mb"]
}

Related Name

Default Value

API Name

monitoring_metric_filter

Required

false

Swap Memory Usage Rate Thresholds

Description: The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_swap_memory_rate_thresholds
Required: false

Swap Memory Usage Rate Window

Description: The period to review when computing unexpected swap memory usage change of the process.
Related Name: common.process.swap_memory_rate_window
Default Value: 5 minute(s)
API Name: process_swap_memory_rate_window
Required: false

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value: Warning: 200 B, Critical: Never
API Name: process_swap_memory_thresholds
Required: false

Role Triggers

Description

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"}]

Related Name

Default Value

[]

API Name

role_triggers

Required

true

Unexpected Exits Thresholds

Description: The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: unexpected_exits_thresholds
Required: false

Unexpected Exits Monitoring Period

Description: The period to review when computing unexpected exits.
Related Name
Default Value: 5 minute(s)
API Name: unexpected_exits_window
Required: false

Other

Kudu Tablet Server Block Cache Capacity

Description: Maximum amount of memory allocated to the Kudu Tablet Server's block cache.
Related Name: block_cache_capacity_mb
Default Value: 512 MiB
API Name: block_cache_capacity_mb
Required: true

Tablet Server Diagnostics Collection Timeout

Description: The timeout in milliseconds to wait for diagnostics collection to complete.
Related Name
Default Value: 1 minute(s)
API Name: csd_role_diagnostics_timeout
Required: false

Kudu Tablet Server Data Directories

Description: Directories where Kudu tablet servers will store data blocks.
Related Name: fs_data_dirs
Default Value
API Name: fs_data_dirs
Required: true

Kudu Tablet Server WAL Directory

Description: Directory where Kudu tablet servers will store write-ahead logs. It can be the same as one of the data directories, but not a sub-directory of a data directory. Master and tablet servers must use different directories when co-located on the same machine.
Related Name: fs_wal_dir
Default Value
API Name: fs_wal_dir
Required: true

Kudu Tablet Server WAL Fsyncs All Entries

Description: If true, the Tablet Server will use the fsync system call to ensure that all writes are durably written to to the write-ahead log (WAL) before responding. If false, edits will be written to the Linux buffer cache on a majority of replicas before responding.
Related Name: log_force_fsync_all
Default Value: false
API Name: log_force_fsync_all
Required: true

Kudu Tablet Server Maintenance Threads

Description: The number of threads devoted to background maintenance operations such as flushes and compactions. If the tablet server appears to be falling behind on write operations (inserts, updates, and deletes) but CPU and disk resources are not saturated, increasing this thread count will devote more resources to these background operations.
Related Name: maintenance_manager_num_threads
Default Value: 1
API Name: maintenance_manager_num_threads
Required: true

Kudu Tablet Server Hard Memory Limit

Description: Maximum amount of memory that the Kudu Tablet Server will use before it starts rejecting all incoming writes.
Related Name: memory_limit_hard_bytes
Default Value: 4 GiB
API Name: memory_limit_hard_bytes
Required: true

Kudu Metrics URL Parameters

Description: The URL query parameters to append to the `/metrics` URL when collecting Kudu metrics.
Related Name: metrics_url_parameters
Default Value: compact=1&level=info
API Name: metrics_url_parameters
Required: true

Tablet History Max Age

Description: The maximum amount of time, in seconds, to preserve tablet data history, including history required to perform diff scans and incremental backups. The duration defined by this parameter is also the maximum amount of time it is possible to wait after a full or incremental backup before performing the next incremental backup. Setting the value to -1 disables history removal.
Related Name: tablet_history_max_age_sec
Default Value: 7 day(s)
API Name: tablet_history_max_age_sec
Required: true

Tablet Server Quiescing Interval

Description: Interval in seconds with which to check whether a Tablet Server has fully quiesced
Related Name: ts_quiescing_retry_interval_sec
Default Value: 30
API Name: ts_quiescing_retry_interval_sec
Required: false

Maximum Allowed Runtime to Quiesce a Tablet Server

Description: Maximum time to wait for a Tablet Server to fully quiesce, relinquishing leadership of all Tablets and completion of all active scans.
Related Name: ts_quiescing_time_limit_sec
Default Value: 1800
API Name: ts_quiescing_time_limit_sec
Required: false

Kudu Tablet Server Core Dump Directory

Description: If Enable Core Dump is set, Kudu Tablet Servers will dump cores to this location.
Related Name: tserver_core_dump_directory
Default Value: /var/log/kudu
API Name: tserver_core_dump_directory
Required: true

Kudu Tablet Server Web UI Interface

Description: The interface of the Kudu Tablet Server Web UI. If blank, binds to 0.0.0.0.
Related Name: webserver_interface
Default Value
API Name: webserver_interface
Required: false

Performance

Maximum Process File Descriptors

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

Ports and Addresses

Kudu Tablet Server Web UI Port

Description: The port of the Kudu Tablet Server Web UI.
Related Name: webserver_port
Default Value: 8050
API Name: webserver_port
Required: true

Resource Management

Cgroup CPU Shares

Description: Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager.
Related Name: cpu.shares
Default Value: 1024
API Name: rm_cpu_shares
Required: true

Custom Control Group Resources (overrides Cgroup settings)

Description: Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
Related Name: custom.cgroups
Default Value
API Name: rm_custom_resources
Required: false

Cgroup I/O Weight

Description: Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager.
Related Name: blkio.weight
Default Value: 500
API Name: rm_io_weight
Required: true

Cgroup Memory Hard Limit

Description: Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_hard_limit
Required: true

Cgroup Memory Soft Limit

Description: Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.soft_limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_soft_limit
Required: true

Security

Enable TLS/SSL for Tablet Server

Description: Encrypt communication between clients and Tablet Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name: ssl_enabled
Default Value: false
API Name: ssl_enabled
Required: false

Tablet Server TLS/SSL Server CA Certificate (PEM Format)

Description: The path to the TLS/SSL file containing the certificate of the certificate authority (CA) and any intermediate certificates used to sign the server certificate. Used when Tablet Server is acting as a TLS/SSL server. The certificate file must be in PEM format, and is usually created by concatenating all of the appropriate root and intermediate certificates.
Related Name
Default Value
API Name: ssl_server_ca_certificate_location
Required: false

Tablet Server TLS/SSL Server Certificate File (PEM Format)

Description: The path to the TLS/SSL file containing the server certificate key used for TLS/SSL. Used when Tablet Server is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name: webserver_certificate_file
Default Value
API Name: ssl_server_certificate_location
Required: false

Tablet Server TLS/SSL Server Private Key File (PEM Format)

Description: The path to the TLS/SSL file containing the private key used for TLS/SSL. Used when Tablet Server is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name: webserver_private_key_file
Default Value
API Name: ssl_server_privatekey_location
Required: false

Tablet Server TLS/SSL Private Key Password

Description: The password for the private key in the Tablet Server TLS/SSL Server Certificate and Private Key file. If left blank, the private key is not protected by a password.
Related Name: webserver_private_key_password_cmd
Default Value
API Name: ssl_server_privatekey_password
Required: false

Suppressions

Suppress Parameter Validation: Kudu Tablet Server Block Cache Capacity

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Tablet Server Block Cache Capacity parameter.
Related Name
Default Value: false
API Name: role_config_suppression_block_cache_capacity_mb
Required: true

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: Kudu Tablet Server Data Directories

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Tablet Server Data Directories parameter.
Related Name
Default Value: false
API Name: role_config_suppression_fs_data_dirs
Required: true

Suppress Parameter Validation: Kudu Tablet Server WAL Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Tablet Server WAL Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_fs_wal_dir
Required: true

Suppress Parameter Validation: Tablet Server Advanced Configuration Snippet (Safety Valve) for gflagfile

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Tablet Server Advanced Configuration Snippet (Safety Valve) for gflagfile parameter.
Related Name
Default Value: false
API Name: role_config_suppression_gflagfile_role_safety_valve
Required: true

Suppress Parameter Validation: Tablet Server Advanced Configuration Snippet (Safety Valve) for kudu-monitoring.properties

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Tablet Server Advanced Configuration Snippet (Safety Valve) for kudu-monitoring.properties parameter.
Related Name
Default Value: false
API Name: role_config_suppression_kudu-monitoring.properties_role_safety_valve
Required: true

Suppress Parameter Validation: Tablet Server Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Tablet Server Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_kudu_tserver_role_env_safety_valve
Required: true

Suppress Parameter Validation: Tablet Server Log Directory

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

Suppress Parameter Validation: Kudu Tablet Server Maintenance Threads

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Tablet Server Maintenance Threads parameter.
Related Name
Default Value: false
API Name: role_config_suppression_maintenance_manager_num_threads
Required: true

Suppress Parameter Validation: Kudu Tablet Server Hard Memory Limit

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Tablet Server Hard Memory Limit parameter.
Related Name
Default Value: false
API Name: role_config_suppression_memory_limit_hard_bytes
Required: true

Suppress Parameter Validation: Kudu Metrics URL Parameters

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Metrics URL Parameters parameter.
Related Name
Default Value: false
API Name: role_config_suppression_metrics_url_parameters
Required: true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Parameter Validation: Role Triggers

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

Suppress Parameter Validation: Tablet Server TLS/SSL Server CA Certificate (PEM Format)

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

Suppress Parameter Validation: Tablet Server TLS/SSL Server Certificate File (PEM Format)

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

Suppress Parameter Validation: Tablet Server TLS/SSL Server Private Key File (PEM Format)

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

Suppress Parameter Validation: Tablet Server TLS/SSL Private Key Password

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

Suppress Parameter Validation: Kudu Tablet Server Core Dump Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Tablet Server Core Dump Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_tserver_core_dump_directory
Required: true

Suppress Parameter Validation: Kudu Tablet Server Web UI Interface

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Tablet Server Web UI Interface parameter.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_interface
Required: true

Suppress Parameter Validation: Kudu Tablet Server Web UI Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kudu Tablet Server Web UI Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_port
Required: true

Suppress Health Test: Failed Data Directories

Description: Whether to suppress the results of the Failed Data Directories heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu-kudu_tserver-7.1.0-failed_data_dirs
Required: true

Suppress Health Test: Full Data Directories

Description: Whether to suppress the results of the Full Data Directories heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu-kudu_tserver-7.1.0-full_data_dirs
Required: true

Suppress Health Test: Audit Pipeline Test

Description: Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_tserver_audit_health
Required: true

Suppress Health Test: File Descriptors

Description: Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_tserver_file_descriptor
Required: true

Suppress Health Test: Host Health

Description: Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_tserver_host_health
Required: true

Suppress Health Test: Log Directory Free Space

Description: Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_tserver_log_directory_free_space
Required: true

Suppress Health Test: Process Status

Description: Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_tserver_scm_health
Required: true

Suppress Health Test: Swap Memory Usage

Description: Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_tserver_swap_memory_usage
Required: true

Suppress Health Test: Swap Memory Usage Rate Beta

Description: Whether to suppress the results of the Swap Memory Usage Rate Beta heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_tserver_swap_memory_usage_rate
Required: true

Suppress Health Test: Unexpected Exits

Description: Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_kudu_kudu_tserver_unexpected_exits
Required: true