Impala Properties in Cloudera Runtime 7.3.1

Role groups:

Impala Catalog Server

Advanced

Catalog Server Command Line Argument Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, key-value pairs (one on each line) to be added (verbatim) to Catalog Server command line flags. Key names should begin with a hyphen(-). For example: -log_filename=foo.log
Related Name
Default Value
API Name: catalogd_cmd_args_safety_valve
Required: false

Impala Catalog Server Advanced Configuration Snippet (Safety Valve) for core-site.xml

Description: For advanced use only. A string to be inserted into core-site.xml for this role only.
Related Name
Default Value
API Name: catalogd_core_site_safety_valve
Required: false

Catalog Server HBase Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into hbase-site.xml for this role only.
Related Name
Default Value
API Name: catalogd_hbase_conf_safety_valve
Required: false

Catalog Server HDFS Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into hdfs-site.xml for this role only.
Related Name
Default Value
API Name: catalogd_hdfs_site_conf_safety_valve
Required: false

Catalog Server Hive Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into hive-site.xml for this role only.
Related Name
Default Value
API Name: catalogd_hive_conf_safety_valve
Required: false

Java Configuration Options for Catalog Server

Description: These arguments will be passed as part of the Java command line. Commonly, garbage collection flags, PermGen, or extra debugging flags would be passed here. Note: When CM version is 6.3.0 or greater, {{JAVA_GC_ARGS}} will be replaced by JVM Garbage Collection arguments based on the runtime Java JVM version.
Related Name
Default Value
API Name: catalogd_java_opts
Required: false

Impala Catalog 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: CATALOGSERVER_role_env_safety_valve
Required: false

Catalog Server Core Dump Directory

Description: Directory where the Catalog Server core dump is placed.
Related Name: core_dump_dir
Default Value: /var/log/catalogd
API Name: core_dump_dir
Required: false

Catalog Server Hive Metastore Connection Retries

Description: Number of retry attempts the Catalog Server will make when connecting to the Hive Metastore Server. By default, the Catalog Server waits one second between retries.
Related Name: hive.metastore.connect.retries
Default Value: 5
API Name: hive_metastore_connect_retries
Required: false

Catalog Server Hive Metastore Connection Timeout

Description: Timeout for requests to the Hive Metastore Server from Catalog Server. Consider increasing this if you have tables with a lot of metadata and see timeout errors.
Related Name: hive.metastore.client.socket.timeout
Default Value: 1 hour(s)
API Name: hive_metastore_timeout
Required: false

Metastore Notification Polling Interval

Description: The value of this configuration determines the interval with which the Catalog Server fetches new notifications from Hive Metastore. The feature is disabled when it is set to 0.
Related Name: hms_event_polling_interval_s
Default Value: 2 second(s)
API Name: hms_event_polling_interval_s
Required: false

Load Catalog in Background

Description: If true, loads catalog metadata in the background. If false, metadata is loaded lazily (on access). Only effective in CDH 5 and Impala 1.2.4 and higher.
Related Name: load_catalog_in_background
Default Value: false
API Name: load_catalog_in_background
Required: false

Catalog Server Max Breakpad Dump Files

Description: Maximum number of Breakpad dump files stored by Catalog Server Role.
Related Name: max_minidumps
Default Value: 9
API Name: max_minidumps
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

Catalog Server Breakpad Dump Directory

Description: Directory for storing Catalog Server Breakpad dumps.
Related Name: minidump_path
Default Value: /var/log/impala-minidumps
API Name: minidump_path
Required: false

Heap Dump Directory

Description: Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role.
Related Name: oom_heap_dump_dir
Default Value: /tmp
API Name: oom_heap_dump_dir
Required: false

Dump Heap When Out of Memory

Description: When set, generates a heap dump file when when an out-of-memory error occurs.
Related Name
Default Value: false
API Name: oom_heap_dump_enabled
Required: true

Kill When Out of Memory

Description: When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value: true
API Name: oom_sigkill_enabled
Required: true

Automatically Restart Process

Description: When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
Related Name
Default Value: true
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

Catalog Server Log Directory

Description: Directory where Catalog Server will place its log files.
Related Name: log_dir
Default Value: /var/log/catalogd
API Name: log_dir
Required: false

Impala Catalog Server Logging Threshold

Description: The minimum log level for Impala Catalog Server logs
Related Name
Default Value: INFO
API Name: log_threshold
Required: false

Catalog Server Verbose Log Level

Description: Verbose logging level for the GLog logger. These messages are always logged at 'INFO' log level, so this setting has no effect if Logging Threshold is set to 'WARN' or above.
Related Name: GLOG_v
Default Value: 1
API Name: log_verbose_level
Required: false

Catalog Server Log Buffer Level

Description: Buffer log messages logged at this level or lower (-1 means don't buffer; 0 means buffer INFO only; 1 means buffer WARNING only, ...)
Related Name: logbuflevel
Default Value: 0
API Name: logbuflevel
Required: false

Catalog Server Maximum Log Files

Description: The number of log files that are kept for each severity level before all older log files are removed. The number has to be greater than 1 to keep at least the current log file open. If set to 0, all log files are retained and log rotation is effectively disabled.
Related Name: max_log_files
Default Value: 10
API Name: max_log_files
Required: false

Impala Catalog Server Max Log Size

Description: The maximum size, in megabytes, per log file for Impala Catalog Server logs. Typically used by log4j or logback.
Related Name
Default Value: 200 MiB
API Name: max_log_size
Required: false

Monitoring

Catalog Server Connectivity Health Test

Description: Enables the health test that verifies the Catalog Server is connected to the StateStore
Related Name
Default Value: true
API Name: catalogserver_connectivity_health_enabled
Required: false

Catalog Server Connectivity Tolerance at Startup

Description: The amount of time to wait for the Catalog Server to fully start up and connect to the StateStore before enforcing the connectivity check.
Related Name
Default Value: 3 minute(s)
API Name: catalogserver_connectivity_tolerance
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: catalogserver_fd_thresholds
Required: false

Impala Catalog Server Host Health Test

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

Impala Catalog Server Process Health Test

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

Health Test Startup Tolerance

Description: The amount of time allowed after this role is started that failures of health tests that rely on communication with this role will be tolerated.
Related Name
Default Value: 5 minute(s)
API Name: catalogserver_startup_tolerance
Required: false

Web Metric Collection

Description: Enables the health test that the Cloudera Manager Agent can successfully contact and gather metrics from the web server.
Related Name
Default Value: true
API Name: catalogserver_web_metric_collection_enabled
Required: false

Web Metric Collection Duration

Description: The health test thresholds on the duration of the metrics request to the web server.
Related Name
Default Value: Warning: 10 second(s), Critical: Never
API Name: catalogserver_web_metric_collection_thresholds
Required: false

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

Heap Dump Directory Free Space Monitoring Absolute Thresholds

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

Heap Dump Directory Free Space Monitoring Percentage Thresholds

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

Enable JMX Exporter (beta)

Description: JMX Exporter support is a beta feature. If enabled, CM configures the role to run JMX Exporter in agent mode with the provided port and YAML configuration. This exporter then can be used with the OpenTelemetry Collector feature. See the JMX Exporter documentation.
Related Name
Default Value: true
API Name: jmx_exporter_enabled
Required: true

JMX Exporter configuration YAML

Description: This configuration is passed to JMX Exporter as it is. See the JMX Exporter documentation.
Related Name
Default Value
API Name: jmx_exporter_yaml
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

Navigator Audit Failure Thresholds

Description: The health test thresholds for failures encountered when monitoring audits within a recent period specified by the mgmt_navigator_failure_window configuration for the role. The value that can be specified for this threshold is the number of bytes of audits data that is left to be sent to audit server.
Related Name: mgmt.navigator.failure.thresholds
Default Value: Warning: Never, Critical: Any
API Name: mgmt_navigator_failure_thresholds
Required: false

Monitoring Period For Audit Failures

Description: The period to review when checking if audits are blocked and not getting processed.
Related Name: mgmt.navigator.failure.window
Default Value: 20 minute(s)
API Name: mgmt_navigator_failure_window
Required: false

Navigator Audit Pipeline Health Check

Description: Enable test of audit events processing pipeline. This will test if audit events are not getting processed by Audit Server for a role that generates audit.
Related Name: mgmt.navigator.status.check.enabled
Default Value: true
API Name: mgmt_navigator_status_check_enabled
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

OpenTelemetry Collector Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: exporters: prometheusremotewrite/$ROLE_NAME: endpoint: $ROLE_PARAM(otelcol_remote_write_url) auth: authenticator: basicauth/$ROLE_NAME tls: insecure_skip_verify: true retry_on_failure: enabled: true initial_interval: 10s max_interval: 40s max_elapsed_time: 300s
API Name: otelcol_exporters
Required: false

OpenTelemetry Collector Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: extensions: basicauth/$ROLE_NAME: client_auth: username: $ROLE_PARAM(otelcol_remote_write_user) password: '$ROLE_PARAM(otelcol_remote_write_password)' spnegoauth/$ROLE_NAME: enabled: $ROLE_BOOLEAN_PARAM(hadoop_secure_web_ui, true, false) realm: '$KRB_REALM' principal: 'HTTP/$HOST_NAME' krb5_conf_path: '$KRB_CONF_PATH' keytab_path: $TARGET_PROC_DIR/impala.keytab http_forwarder/$ROLE_NAME: ingress: endpoint: localhost:$ROLE_PARAM(otelcol_helper_port) egress: endpoint: $ROLE_BOOLEAN_PARAM(client_services_ssl_enabled, https, http)://$HOST_NAME:$ROLE_PARAM(catalogserver_webserver_port)/ auth: authenticator: spnegoauth/$ROLE_NAME tls: insecure_skip_verify: true headers: otel_http_forwarder: dev timeout: 5s
API Name: otelcol_extensions
Required: false

OpenTelemetry Collector Helper Port

Description: This port can be used for JMX Exporter to implement a Prometheus exporter or for other OpenTelemetry Collector related purposes
Related Name
Default Value: 11151
API Name: otelcol_helper_port
Required: false

OpenTelemetry Collector Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: processors: filter/$ROLE_NAME: metrics: include: match_type: strict metric_names: - impala_rpc_method_catalog_server_CatalogService_GetPartialCatalogObject_call_duration - impala_thrift_server_CatalogService_svc_thread_wait_time - impala_thrift_server_CatalogService_connection_setup_time - impala_thrift_server_CatalogService_timedout_cnxn_requests - impala_statestore_subscriber_statestore_client_cache_clients_in_use - impala_tcmalloc_pageheap_unmapped_bytes - impala_tcmalloc_pageheap_free_bytes - impala_jvm_heap_committed_usage_bytes - impala_jvm_heap_current_usage_bytes - impala_jvm_heap_init_usage_bytes - impala_jvm_heap_max_usage_bytes - impala_statestore_subscriber_heartbeat_interval_time_total
API Name: otelcol_processors
Required: false

OpenTelemetry Collector Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value: receivers: prometheus/$ROLE_NAME: config: scrape_configs: - job_name: 'DMP-$ROLE_NAME' scrape_interval: 60s scheme: http metrics_path: '/metrics_prometheus' tls_config: insecure_skip_verify: true static_configs: - targets: ['localhost:$ROLE_PARAM(otelcol_helper_port)'] labels: host_name: $HOST_NAME cm_cluster_id: $CLUSTER_ID service_type: $SERVICE_TYPE service: $SERVICE_NAME role_type: $ROLE_TYPE role_name: $ROLE_NAME instance: $INFRA(instance_id) cluster_id: $INFRA(cluster_id) platform: $INFRA(platform) formfactor: paas-vm relabel_configs: - source_labels: [cluster_id] regex: 'crn:cdp:([^:]+):.*' replacement: '$$1' target_label: app_type action: replace
API Name: otelcol_receivers
Required: false

OpenTelemetry Collector Remote Write Password

Description: Remote write password for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_password) expression. Specify $INFRA(cdp_request_signer_password) when forwarding to Cloudera Observability central monitoring. (This is the default.)
Related Name
Default Value: ******
API Name: otelcol_remote_write_password
Required: false

OpenTelemetry Collector Remote Write URL

Description: Remote write URL for the OpenTelemetry Collector. This param is for convenience and intended to be used at the exporters section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_url) expression. Specify $INFRA(cdp_request_signer_url) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_url)
API Name: otelcol_remote_write_url
Required: false

OpenTelemetry Collector Remote Write Username

Description: Remote write username for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_user) expression. Specify $INFRA(cdp_request_signer_username) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_username)
API Name: otelcol_remote_write_user
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_rtm_logs_exporters
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_rtm_logs_extensions
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_rtm_logs_processors
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value
API Name: otelcol_rtm_logs_receivers
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_rtm_logs_service
Required: false

OpenTelemetry Collector Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: service: pipelines: metrics/$ROLE_NAME: receivers: [prometheus/$ROLE_NAME] processors: [filter/$ROLE_NAME] exporters: [prometheusremotewrite/$ROLE_NAME]
API Name: otelcol_service
Required: false

Enable OpenTelemetry Collector (beta)

Description: OpenTelemetry Collector support is a new beta feature (will change without notice) which can run OpenTelemetry Collector as an agent together with the CM Agent to forward metrics to a Prometheus like storage.
Related Name
Default Value: true
API Name: otelcol_should_collect
Required: true

Enable Real-Time Monitoring for Jobs / Queries with OpenTelemetry

Description: This enables OpenTelemetry Collector as an agent together with the CM Agent to forward real-time monitoring data about jobs / queries to Observability backend. The configuration of the subsections shouldn't be modified manually.
Related Name
Default Value: false
API Name: otelcol_should_collect_rtm_logs
Required: true

Resident Set Size Thresholds

Description: The health test thresholds on the resident size of the process.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_resident_set_size_thresholds
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

Enable Spool Directory Metric Usage for Impala Catalog Server

Description: Enables the health test for monitoring the Ranger Plugin Spool directory usage.
Related Name
Default Value: true
API Name: spool_directory_usage_enabled
Required: false

Ranger Plugin Spool Directory Usage Thresholds for Impala Catalog Server

Description: The health test thresholds for monitoring the the Ranger Plugin Spool directory usage.
Related Name
Default Value: 1 GiB
API Name: spool_directory_usage_threshold
Required: false

Unexpected Exits Thresholds

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

Unexpected Exits Monitoring Period

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

Other

Enable Catalog Server Web Server

Description: Enable/Disable Catalog Server web server. This web server contains useful information about Catalog Server daemon.
Related Name: enable_webserver
Default Value: true
API Name: catalogd_enable_webserver
Required: false

Force the Catalog Server active

Description: Force the Catalog Server to be always active under HA mode if it is online.
Related Name: force_catalogd_active
Default Value: false
API Name: force_catalogd_active
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

Catalog Server Service Port

Description: Port where Catalog Server is exported.
Related Name: catalog_service_port
Default Value: 26000
API Name: catalog_service_port
Required: false

Catalog Server HTTP Server Port

Description: Port where Catalog Server debug web server runs.
Related Name: webserver_port
Default Value: 25020
API Name: catalogserver_webserver_port
Required: false

Resource Management

Java Heap Size of Catalog Server in Bytes

Description: Maximum size in bytes for the Java Process heap memory. Passed to Java -Xmx.
Related Name
Default Value: 4 GiB
API Name: catalogd_embedded_jvm_heapsize
Required: false

Cgroup V1 BLKIO Weight

Description: Weight for the read I/O requests issued by this role, enforced by the Linux kernel under cgroup v1. 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_blkio_weight
Required: true

Cgroup V1 CPU Shares

Description: Number of CPU shares to assign to this role, enforced by the Linux kernel under cgroup v1. 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

Cgroup V2 CPU Weight

Description: Weight of CPU resources to assign to this role, enforced by the Linux kernel under cgroup v2. The greater the weight, 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 1 and 10000. Defaults to 100.
Related Name: cpu.weight
Default Value: 100
API Name: rm_cpu_weight
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 V2 I/O Weight

Description: Weight for the I/O requests issued by this role, enforced by the Linux kernel under cgroup v2. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 1 and 10000. Defaults to 100.
Related Name: io.weight
Default Value: 100
API Name: rm_io_weight
Required: true

Cgroup V1 Memory Hard Limit

Description: Hard memory limit to assign to this role, enforced by the Linux kernel under cgroup v1. 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_v1
Required: true

Cgroup V2 Memory Hard Limit

Description: Hard memory limit to assign to this role, enforced by the Linux kernel under cgroup v2. 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 and page cache pages contribute to the limit. Use a value of 'max' to specify no limit. By default, processes not managed by Cloudera Manager will have no limit. If the value is 'max', Cloudera Manager will not monitor Cgroup memory usage, and some charts will show 'No Data'.
Related Name: memory.max
Default Value: -1 MiB
API Name: rm_memory_hard_limit_v2
Required: true

Cgroup V1 Memory Soft Limit

Description: Soft memory limit to assign to this role, enforced by the Linux kernel under cgroup v1. 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_v1
Required: true

Cgroup V2 Memory Soft Limit

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

Security

Catalog Server Webserver 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 Catalog Server Webserver is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name: webserver_certificate_file
Default Value
API Name: webserver_certificate_file
Required: false

Catalog Server Web Server User Password

Description: Password for Catalog Server web server authentication.
Related Name: webserver_htpassword_password
Default Value
API Name: webserver_htpassword_password
Required: false

Catalog Server Web Server Username

Description: Username for Catalog Server web server authentication.
Related Name: webserver_htpassword_user
Default Value
API Name: webserver_htpassword_user
Required: false

Catalog Server Webserver 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 Catalog Server Webserver 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: webserver_private_key_file
Required: false

Catalog Server Webserver TLS/SSL Private Key Password

Description: The password for the private key in the Catalog Server Webserver 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: webserver_private_key_password_cmd
Required: false

Stacks Collection

Stacks Collection Data Retention

Description: The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
Related Name: stacks_collection_data_retention
Default Value: 100 MiB
API Name: stacks_collection_data_retention
Required: false

Stacks Collection Directory

Description: The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race.
Related Name: stacks_collection_directory
Default Value
API Name: stacks_collection_directory
Required: false

Stacks Collection Enabled

Description: Whether or not periodic stacks collection is enabled.
Related Name: stacks_collection_enabled
Default Value: false
API Name: stacks_collection_enabled
Required: true

Stacks Collection Frequency

Description: The frequency with which stacks are collected.
Related Name: stacks_collection_frequency
Default Value: 5.0 second(s)
API Name: stacks_collection_frequency
Required: false

Stacks Collection Method

Description: The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped.
Related Name: stacks_collection_method
Default Value: jstack
API Name: stacks_collection_method
Required: false

Suppressions

Suppress Parameter Validation: Catalog Server Service Port

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

Suppress Parameter Validation: Catalog Server Command Line Argument Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: Impala Catalog Server Advanced Configuration Snippet (Safety Valve) for core-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Catalog Server Advanced Configuration Snippet (Safety Valve) for core-site.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_catalogd_core_site_safety_valve
Required: true

Suppress Parameter Validation: Catalog Server HBase Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: Catalog Server HDFS Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: Catalog Server Hive Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: Java Configuration Options for Catalog Server

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Configuration Options for Catalog Server parameter.
Related Name
Default Value: false
API Name: role_config_suppression_catalogd_java_opts
Required: true

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

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

Suppress Parameter Validation: Catalog Server HTTP Server Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Catalog Server HTTP Server Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_catalogserver_webserver_port
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: Catalog Server Core Dump Directory

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

Suppress Parameter Validation: JMX Exporter configuration YAML

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter configuration YAML parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_yaml
Required: true

Suppress Parameter Validation: Catalog Server Log Directory

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

Suppress Parameter Validation: Catalog Server Breakpad Dump Directory

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

Suppress Parameter Validation: Heap Dump Directory

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

Suppress Parameter Validation: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Helper Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Helper Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_helper_port
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_exporters
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_extensions
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_processors
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_receivers
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_service
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
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: Stacks Collection Directory

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

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

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

Suppress Parameter Validation: Catalog Server Web Server User Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Catalog Server Web Server User Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_htpassword_password
Required: true

Suppress Parameter Validation: Catalog Server Web Server Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Catalog Server Web Server Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_htpassword_user
Required: true

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

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

Suppress Parameter Validation: Catalog Server Webserver TLS/SSL Private Key Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Catalog Server Webserver TLS/SSL Private Key Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_private_key_password_cmd
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_catalogserver_audit_health
Required: true

Suppress Health Test: StateStore Connectivity

Description: Whether to suppress the results of the StateStore Connectivity 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_catalogserver_connectivity
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_catalogserver_file_descriptor
Required: true

Suppress Health Test: Heap Dump Directory Free Space

Description: Whether to suppress the results of the Heap Dump 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_catalogserver_heap_dump_directory_free_space
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_catalogserver_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_catalogserver_log_directory_free_space
Required: true

Suppress Health Test: Resident Set Size

Description: Whether to suppress the results of the Resident Set Size 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_catalogserver_memory_rss_health
Required: true

Suppress Health Test: Otelcol Health

Description: Whether to suppress the results of the Otelcol 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_catalogserver_otelcol_health
Required: true

Suppress Health Test: Ranger Plugin Hdfs Spool Directory Size

Description: Whether to suppress the results of the Ranger Plugin Hdfs Spool Directory Size 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_catalogserver_ranger_plugin_hdfs_spool_directory_size_health
Required: true

Suppress Health Test: Ranger Plugin Solr Spool Directory Size

Description: Whether to suppress the results of the Ranger Plugin Solr Spool Directory Size 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_catalogserver_ranger_plugin_solr_spool_directory_size_health
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_catalogserver_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_catalogserver_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_catalogserver_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_catalogserver_unexpected_exits
Required: true

Suppress Health Test: Web Server Status

Description: Whether to suppress the results of the Web Server 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_catalogserver_web_metric_collection
Required: true

Impala Daemon

Advanced

Abort on Config Error

Description: Abort Impala startup if there are improper configs or running on unsupported hardware.
Related Name: abort_on_config_error
Default Value: true
API Name: abort_on_config_error
Required: false

Impala Daemon Core Dump Directory

Description: Directory where an Impala Daemon core dump is placed.
Related Name: core_dump_dir
Default Value: /var/log/impalad
API Name: core_dump_dir
Required: false

Impala Daemon Max Client Connections

Description: Maximum number of concurrent client connections allowed. This determines how many queries can run simultaneously. When more clients try to connect to Impala than the value of this setting, the later arriving clients have to wait until previous clients disconnect. Setting this value too high could negatively impact query latency.
Related Name: fe_service_threads
Default Value: 64
API Name: fe_service_threads
Required: false

Impala Daemon Hive Metastore Connection Retries

Description: Number of retry attempts the Impala Daemon will make when connecting to the Hive Metastore Server. By default, the Impala Daemon waits one second between retries.
Related Name: hive.metastore.connect.retries
Default Value: 5
API Name: hive_metastore_connect_retries
Required: false

Impala Daemon Hive Metastore Connection Timeout

Description: Timeout for requests to the Hive Metastore Server from Impala. Consider increasing this if you have tables with a lot of metadata and see timeout errors.
Related Name: hive.metastore.client.socket.timeout
Default Value: 1 hour(s)
API Name: hive_metastore_timeout
Required: false

Impala Daemon HDFS Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into hdfs-site.xml for this role only.
Related Name
Default Value
API Name: impala_hdfs_site_conf_safety_valve
Required: false

Impala Daemon Hive Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into hive-site.xml for this role only.
Related Name
Default Value
API Name: impala_hive_conf_safety_valve
Required: false

Impala Daemon Llama Site Advanced Configuration Snippet (Safety Valve)

Description: An XML snippet to append to llama-site.xml for Impala Daemons. This configuration only has effect on Impala versions 1.3 or greater.
Related Name
Default Value
API Name: impala_llama_site_conf_safety_valve
Required: false

Impala Daemon Command Line Argument Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, key-value pairs (one on each line) to be added (verbatim) to Impala Daemon command-line flags. Key names should begin with a hyphen(-). For example: -log_filename=foo.log
Related Name
Default Value
API Name: impalad_cmd_args_safety_valve
Required: false

Impala Daemon Advanced Configuration Snippet (Safety Valve) for core-site.xml

Description: For advanced use only. A string to be inserted into core-site.xml for this role only.
Related Name
Default Value
API Name: impalad_core_site_safety_valve
Required: false

Java Configuration Options for Impala Daemon

Description: These arguments will be passed as part of the Java command line. Commonly, garbage collection flags, PermGen, or extra debugging flags would be passed here. Note: When CM version is 6.3.0 or greater, {{JAVA_GC_ARGS}} will be replaced by JVM Garbage Collection arguments based on the runtime Java JVM version.
Related Name: Impala Daemon Java Options
Default Value
API Name: impalad_embedded_java_opts
Required: false

Impala Daemon Fair Scheduler Advanced Configuration Snippet (Safety Valve)

Description: An XML string to use verbatim for the contents of fair-scheduler.xml for Impala Daemons. This configuration only has effect on Impala versions 1.3 or greater.
Related Name
Default Value
API Name: impalad_fair_scheduler_safety_valve
Required: false

Impala Daemon HBase Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into hbase-site.xml for this role only.
Related Name
Default Value
API Name: impalad_hbase_conf_safety_valve
Required: false

Result Cache Maximum Size

Description: Maximum number of query results a client may request to be cached on a per-query basis to support restarting fetches. This option guards against unreasonably large result caches requested by clients. Requests exceeding this maximum will be rejected.
Related Name: max_result_cache_size
Default Value: 100000
API Name: impalad_result_cache_max_size
Required: false

Impala Daemon 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: IMPALAD_role_env_safety_valve
Required: false

Llama Maximum Request Attempts

Description: Maximum number of times a request to reserve, expand, or release resources is attempted until the request is cancelled.
Related Name: llama_max_request_attempts
Default Value: 5
API Name: llama_max_request_attempts
Required: false

Llama Registration Timeout Seconds

Description: Maximum number of seconds that Impala attempts to register or re-register with Llama. If registration is unsuccessful, Impala cancels the action with an error, which could result in an impalad startup failure or a cancelled query. A setting of -1 seconds means try indefinitely.
Related Name: llama_registration_timeout_secs
Default Value: 30 second(s)
API Name: llama_registration_timeout_secs
Required: false

Llama Registration Wait Seconds

Description: Number of seconds to wait between attempts during Llama registration.
Related Name: llama_registration_wait_secs
Default Value: 3 second(s)
API Name: llama_registration_wait_secs
Required: false

Impala Daemon Logging Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into log4j.properties for this role only.
Related Name
Default Value
API Name: log4j_safety_valve
Required: false

Impala Daemon Max Breakpad Dump Files

Description: Maximum number of Breakpad dump files stored by Impala Daemon Role.
Related Name: max_minidumps
Default Value: 9
API Name: max_minidumps
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

Impala Daemon Breakpad Dump Directory

Description: Directory for storing Impala Daemon Breakpad dumps.
Related Name: minidump_path
Default Value: /var/log/impala-minidumps
API Name: minidump_path
Required: false

Heap Dump Directory

Description: Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role.
Related Name: oom_heap_dump_dir
Default Value: /tmp
API Name: oom_heap_dump_dir
Required: false

Dump Heap When Out of Memory

Description: When set, generates a heap dump file when when an out-of-memory error occurs.
Related Name
Default Value: false
API Name: oom_heap_dump_enabled
Required: true

Kill When Out of Memory

Description: When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value: true
API Name: oom_sigkill_enabled
Required: true

Automatically Restart Process

Description: When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
Related Name
Default Value: true
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

Impala Daemon Audit Log Directory

Description: The directory in which Impala daemon audit event log files are written. If "Impala Audit Event Generation" property is enabled, Impala will generate its audit logs in this directory.
Related Name: audit_event_log_dir
Default Value: /var/log/impalad/audit
API Name: audit_event_log_dir
Required: true

Enable Impala Audit Event Generation

Description: Enables audit event generation by Impala daemons. The audit log file will be placed in the directory specified by 'Impala Daemon Audit Log Directory' parameter.
Related Name: enable_audit_event_log
Default Value: false
API Name: enable_audit_event_log
Required: false

Enable Impala Lineage Generation

Description: Enables lineage generation by Impala daemons. The lineage log file is placed in the directory specified by the 'Impala Daemon Lineage Log Directory' parameter.
Related Name: enable_lineage_log
Default Value: true
API Name: enable_lineage_log
Required: false

Impala Daemon Lineage Log Directory

Description: The directory in which Impala daemon lineage log files are written. If "Impala Lineage Generation" property is enabled, Impala generates its lineage logs in this directory.
Related Name: lineage_event_log_dir
Default Value: /var/log/impalad/lineage
API Name: lineage_event_log_dir
Required: true

Impala Daemon Log Directory

Description: Directory where Impala Daemon will place its log files.
Related Name: log_dir
Default Value: /var/log/impalad
API Name: log_dir
Required: false

Impala Daemon Logging Threshold

Description: The minimum log level for Impala Daemon logs
Related Name
Default Value: INFO
API Name: log_threshold
Required: false

Impala Daemon Verbose Log Level

Description: Verbose logging level for the GLog logger. These messages are always logged at 'INFO' log level, so this setting has no effect if Logging Threshold is set to 'WARN' or above.
Related Name: GLOG_v
Default Value: 1
API Name: log_verbose_level
Required: false

Impala Daemon Log Buffer Level

Description: Buffer log messages logged at this level or lower (-1 means don't buffer; 0 means buffer INFO only; 1 means buffer WARNING only, ...)
Related Name: logbuflevel
Default Value: 0
API Name: logbuflevel
Required: false

Impala Daemon Maximum Audit Log File Size

Description: The maximum size (in queries) of the Impala Daemon audit event log file before a new one is created.
Related Name: max_audit_event_log_file_size
Default Value: 5000 line(s)
API Name: max_audit_event_log_file_size
Required: false

Impala Daemon Maximum Lineage Log File Size

Description: The maximum size (in entries) of the Impala daemon lineage log file before a new one is created.
Related Name: max_lineage_log_file_size
Default Value: 5000 line(s)
API Name: max_lineage_log_file_size
Required: false

Impala Maximum Log Files

Description: The number of log files that are kept for each severity level before all older log files are removed. The number has to be greater than 1 to keep at least the current log file open. If set to 0, all log files are retained and log rotation is effectively disabled.
Related Name: max_log_files
Default Value: 10
API Name: max_log_files
Required: false

Impala Daemon Max Log Size

Description: The maximum size, in megabytes, per log file for Impala Daemon logs. Typically used by log4j or logback.
Related Name
Default Value: 200 MiB
API Name: max_log_size
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

Query Monitoring Timeout

Description: The timeout used by the Cloudera Manager Agent's query monitor when communicating with the Impala Daemon web server, specified in seconds.
Related Name
Default Value: 15.0 second(s)
API Name: executing_queries_timeout_seconds
Required: false

Heap Dump Directory Free Space Monitoring Absolute Thresholds

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

Heap Dump Directory Free Space Monitoring Percentage Thresholds

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

Query Monitoring Failures Thresholds

Description: The health test thresholds for failures encountered when monitoring queries within a recent period specified by the impala_query_monitoring_failure_window configuration for the role.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: impala_query_monitoring_failure_thresholds
Required: false

Monitoring Period For Query Monitoring Failures

Description: The period to review when computing query monitoring failures.
Related Name
Default Value: 5 minute(s)
API Name: impala_query_monitoring_failure_window
Required: false

Impala Daemon Query Collection Status Health Check

Description: Enables the health check that determines if query collection for the Impala Daemon is successful.
Related Name
Default Value: true
API Name: impala_query_monitoring_status_check_enabled
Required: false

Impala Daemon Connectivity Health Test

Description: Enables the health test that verifies the Impala Daemon is connected to the StateStore.
Related Name
Default Value: true
API Name: impalad_connectivity_health_enabled
Required: false

Impala Daemon Connectivity Tolerance at Startup

Description: The amount of time to wait for the Impala Daemon to fully start up and connect to the StateStore before enforcing the connectivity check.
Related Name
Default Value: 3 minute(s)
API Name: impalad_connectivity_tolerance
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: impalad_fd_thresholds
Required: false

Impala Daemon Concurrent Client Connections Monitoring Percentage Thresholds

Description: The health check thresholds for monitoring of the number of concurrent client connections to Impala Daemon. Specified as a percentage of the maximum client connections parameter.
Related Name
Default Value: Warning: 80.0 %, Critical: 95.0 %
API Name: impalad_frontend_connections_thresholds
Required: false

Impala Daemon Host Health Test

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

Pause Duration Thresholds

Description: The health test thresholds for the weighted average extra time the pause monitor spent paused. Specified as a percentage of elapsed wall clock time.
Related Name
Default Value: Warning: 30.0, Critical: 60.0
API Name: impalad_pause_duration_thresholds
Required: false

Pause Duration Monitoring Period

Description: The period to review when computing the moving average of extra time the pause monitor spent paused.
Related Name
Default Value: 5 minute(s)
API Name: impalad_pause_duration_window
Required: false

Impala Daemon Ready Status Health Check

Description: Enables the health check that determines if the Impala daemon is ready to process queries.
Related Name
Default Value: true
API Name: impalad_ready_status_check_enabled
Required: false

Impala Daemon Ready Status Startup Tolerance

Description: The amount of time at Impala Daemon startup allowed for the Impala Daemon to start accepting new queries for processing.
Related Name
Default Value: 3 minute(s)
API Name: impalad_ready_status_check_startup_tolerance
Required: false

Impala Daemon Process Health Test

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

Impala Daemon Scratch Directories Free Space Monitoring Absolute Thresholds

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

Impala Daemon Scratch Directories Free Space Monitoring Percentage Thresholds

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

Web Metric Collection

Description: Enables the health test that the Cloudera Manager Agent can successfully contact and gather metrics from the web server.
Related Name
Default Value: true
API Name: impalad_web_metric_collection_enabled
Required: false

Web Metric Collection Duration

Description: The health test thresholds on the duration of the metrics request to the web server.
Related Name
Default Value: Warning: 10 second(s), Critical: Never
API Name: impalad_web_metric_collection_thresholds
Required: false

Enable JMX Exporter (beta)

Description: JMX Exporter support is a beta feature. If enabled, CM configures the role to run JMX Exporter in agent mode with the provided port and YAML configuration. This exporter then can be used with the OpenTelemetry Collector feature. See the JMX Exporter documentation.
Related Name
Default Value: true
API Name: jmx_exporter_enabled
Required: true

JMX Exporter configuration YAML

Description: This configuration is passed to JMX Exporter as it is. See the JMX Exporter documentation.
Related Name
Default Value
API Name: jmx_exporter_yaml
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

Navigator Audit Failure Thresholds

Description: The health test thresholds for failures encountered when monitoring audits within a recent period specified by the mgmt_navigator_failure_window configuration for the role. The value that can be specified for this threshold is the number of bytes of audits data that is left to be sent to audit server.
Related Name: mgmt.navigator.failure.thresholds
Default Value: Warning: Never, Critical: Any
API Name: mgmt_navigator_failure_thresholds
Required: false

Monitoring Period For Audit Failures

Description: The period to review when checking if audits are blocked and not getting processed.
Related Name: mgmt.navigator.failure.window
Default Value: 20 minute(s)
API Name: mgmt_navigator_failure_window
Required: false

Navigator Audit Pipeline Health Check

Description: Enable test of audit events processing pipeline. This will test if audit events are not getting processed by Audit Server for a role that generates audit.
Related Name: mgmt.navigator.status.check.enabled
Default Value: true
API Name: mgmt_navigator_status_check_enabled
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

OpenTelemetry Collector Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: exporters: prometheusremotewrite/$ROLE_NAME: endpoint: $ROLE_PARAM(otelcol_remote_write_url) auth: authenticator: basicauth/$ROLE_NAME tls: insecure_skip_verify: true retry_on_failure: enabled: true initial_interval: 10s max_interval: 40s max_elapsed_time: 300s
API Name: otelcol_exporters
Required: false

OpenTelemetry Collector Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: extensions: basicauth/$ROLE_NAME: client_auth: username: $ROLE_PARAM(otelcol_remote_write_user) password: '$ROLE_PARAM(otelcol_remote_write_password)' spnegoauth/$ROLE_NAME: enabled: $ROLE_BOOLEAN_PARAM(hadoop_secure_web_ui, true, false) realm: '$KRB_REALM' principal: 'HTTP/$HOST_NAME' krb5_conf_path: '$KRB_CONF_PATH' keytab_path: $TARGET_PROC_DIR/impala.keytab http_forwarder/$ROLE_NAME: ingress: endpoint: localhost:$ROLE_PARAM(otelcol_helper_port) egress: endpoint: $ROLE_BOOLEAN_PARAM(client_services_ssl_enabled, https, http)://$HOST_NAME:$ROLE_PARAM(impalad_webserver_port)/ auth: authenticator: spnegoauth/$ROLE_NAME tls: insecure_skip_verify: true headers: otel_http_forwarder: dev timeout: 5s
API Name: otelcol_extensions
Required: false

OpenTelemetry Collector Helper Port

Description: This port can be used for JMX Exporter to implement a Prometheus exporter or for other OpenTelemetry Collector related purposes
Related Name
Default Value: 11150
API Name: otelcol_helper_port
Required: false

OpenTelemetry Collector Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: processors: filter/$ROLE_NAME: metrics: include: match_type: strict metric_names: - impala_tmp_file_mgr_active_scratch_dirs - impala_thread_manager_running_threads - impala_catalog_cache_average_load_time - impala_catalog_cache_load_exception_rate - impala_thrift_server_beeswax_frontend_timedout_cnxn_requests - impala_server_num_queries - impala_server_num_fragments - impala_server_scan_ranges_num_missing_volume_id - impala_thrift_server_beeswax_frontend_connections_in_use - impala_thrift_server_hiveserver2_frontend_connections_in_use - impala_tcmalloc_pageheap_unmapped_bytes - impala_tcmalloc_pageheap_free_bytes - impala_buffer_pool_limit - impala_buffer_pool_system_allocated - impala_buffer_pool_reserved - impala_buffer_pool_free_buffers - impala_buffer_pool_free_buffer_bytes - impala_buffer_pool_clean_pages - impala_buffer_pool_clean_page_bytes - impala_memory_total_used - impala_memory_num_maps - impala_memory_mapped_bytes - impala_memory_rss - impala_memory_anon_huge_page_bytes - impala_jvm_heap_committed_usage_bytes - impala_jvm_heap_current_usage_bytes - impala_jvm_heap_init_usage_bytes - impala_jvm_heap_max_usage_bytes - impala_jvm_gc_time_millis - impala_jvm_gc_total_extra_sleep_time_millis - impala_server_hedged_read_ops - impala_server_hedged_read_ops_win - impala_rpc_impala_DataStreamService_rpcs_queue_overflow - impala_mem_tracker_DataStreamService_current_usage_bytes - impala_mem_tracker_DataStreamService_peak_usage_bytes - impala_server_num_fragments_in_flight - impala_server_num_queries_registered - impala_statestore_subscriber_heartbeat_interval_time_total
API Name: otelcol_processors
Required: false

OpenTelemetry Collector Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value: receivers: prometheus/$ROLE_NAME: config: scrape_configs: - job_name: 'DMP-$ROLE_NAME' scrape_interval: 60s scheme: http metrics_path: '/metrics_prometheus' tls_config: insecure_skip_verify: true static_configs: - targets: ['localhost:$ROLE_PARAM(otelcol_helper_port)'] labels: host_name: $HOST_NAME cm_cluster_id: $CLUSTER_ID service_type: $SERVICE_TYPE service: $SERVICE_NAME role_type: $ROLE_TYPE role_name: $ROLE_NAME instance: $INFRA(instance_id) cluster_id: $INFRA(cluster_id) platform: $INFRA(platform) formfactor: paas-vm relabel_configs: - source_labels: [cluster_id] regex: 'crn:cdp:([^:]+):.*' replacement: '$$1' target_label: app_type action: replace
API Name: otelcol_receivers
Required: false

OpenTelemetry Collector Remote Write Password

Description: Remote write password for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_password) expression. Specify $INFRA(cdp_request_signer_password) when forwarding to Cloudera Observability central monitoring. (This is the default.)
Related Name
Default Value: ******
API Name: otelcol_remote_write_password
Required: false

OpenTelemetry Collector Remote Write URL

Description: Remote write URL for the OpenTelemetry Collector. This param is for convenience and intended to be used at the exporters section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_url) expression. Specify $INFRA(cdp_request_signer_url) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_url)
API Name: otelcol_remote_write_url
Required: false

OpenTelemetry Collector Remote Write Username

Description: Remote write username for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_user) expression. Specify $INFRA(cdp_request_signer_username) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_username)
API Name: otelcol_remote_write_user
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: exporters: dbus/$ROLE_NAME: endpoint: '$DBUS_ENDPOINT' cloudprovider_name: '$DBUS_HEADER_PARAM(cloudprovider_name)' cloudprovider_region: '$DBUS_HEADER_PARAM(cloudprovider_region)' cluster_display_name: '$DBUS_HEADER_PARAM(cluster_display_name)' cluster_id: '$CLUSTER_ID' cm_version: '$DBUS_HEADER_PARAM(cm_version)' data_service_type: '$DBUS_HEADER_PARAM(data_service_type)' datahub_resource_crn: '$DBUS_HEADER_PARAM(datahub_crn)' datalake_crn: '$DBUS_HEADER_PARAM(datalake_crn)' environment_crn: '$DBUS_HEADER_PARAM(environment_crn)' environment_name: '$DBUS_HEADER_PARAM(environment_name)' partition_key: '$CLUSTER_ID' sdx_id: '$DBUS_HEADER_PARAM(sdx_id)' sdx_name: '$DBUS_HEADER_PARAM(sdx_name)' stream_name: 'RealTimeMonitoringData' time_zone: '$DBUS_HEADER_PARAM(time_zone)' exporter_timeout: timeout: '45s' retry_on_failure: enabled: false auth: authenticator: cdpauth/dbus-$ROLE_NAME
API Name: otelcol_rtm_logs_exporters
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: extensions: cdpauth/dbus-$ROLE_NAME: cdp_access_key_id: '$CDP_ACCESS_KEY_ID' send_token: true token_valid_for_sec: 3600 cdp_private_key: $CDP_PRIVATE_KEY cdp_authentication_method: 'rsav1' spnegoauth/$ROLE_NAME: enabled: $ROLE_BOOLEAN_PARAM(hadoop_secure_web_ui, true, false) realm: '$KRB_REALM' principal: 'HTTP/$HOST_NAME' krb5_conf_path: '$KRB_CONF_PATH' keytab_path: $TARGET_PROC_DIR/impala.keytab
API Name: otelcol_rtm_logs_extensions
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: processors: clouderalogredactor/$ROLE_NAME: redaction_rules_json_file_path: $TARGET_PROC_DIR/redaction-rules.json
API Name: otelcol_rtm_logs_processors
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value: receivers: impalareceiver/$ROLE_NAME: max_response_size_bytes: 5242880 scraper: collection_interval: 60s timeout: 45s http: endpoint: '$SSL_PARAM(http_or_https)://$HOST_NAME:$ROLE_PARAM(impalad_webserver_port)' tls: ca_file: $SSL_PARAM(ssl_client_ca_certificate) insecure_skip_verify: true auth: authenticator: spnegoauth/$ROLE_NAME
API Name: otelcol_rtm_logs_receivers
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: service: pipelines: logs/$ROLE_NAME: receivers: - 'impalareceiver/$ROLE_NAME' exporters: - 'dbus/$ROLE_NAME' processors: - 'clouderalogredactor/$ROLE_NAME'
API Name: otelcol_rtm_logs_service
Required: false

OpenTelemetry Collector Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: service: pipelines: metrics/$ROLE_NAME: receivers: [prometheus/$ROLE_NAME] processors: [filter/$ROLE_NAME] exporters: [prometheusremotewrite/$ROLE_NAME]
API Name: otelcol_service
Required: false

Enable OpenTelemetry Collector (beta)

Description: OpenTelemetry Collector support is a new beta feature (will change without notice) which can run OpenTelemetry Collector as an agent together with the CM Agent to forward metrics to a Prometheus like storage.
Related Name
Default Value: true
API Name: otelcol_should_collect
Required: true

Enable Real-Time Monitoring for Jobs / Queries with OpenTelemetry

Description: This enables OpenTelemetry Collector as an agent together with the CM Agent to forward real-time monitoring data about jobs / queries to Observability backend. The configuration of the subsections shouldn't be modified manually.
Related Name
Default Value: true
API Name: otelcol_should_collect_rtm_logs
Required: true

Resident Set Size Thresholds

Description: The health test thresholds on the resident size of the process.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_resident_set_size_thresholds
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: Any, Critical: Any
API Name: process_swap_memory_thresholds
Required: false

Query Monitoring Full Sync Period

Description: The full sync period of the Impala query monitor in the Cloudera Manager Agent, specified in minutes. When a full sync is happening, all query profiles are sent over regardless of having been updated or not. If set to zero, a full sync is performed at each polling period.
Related Name
Default Value: 3.0 minute(s)
API Name: query_monitoring_full_sync_period_minutes
Required: false

Query Monitoring Period

Description: The polling period of the Impala query monitor in the Cloudera Manager Agent, specified in seconds. If set to zero, query monitoring is disabled.
Related Name
Default Value: 120.0 second(s)
API Name: query_monitoring_period_seconds
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

Enable Spool Directory Metric Usage for Impala Daemon

Description: Enables the health test for monitoring the Ranger Plugin Spool directory usage.
Related Name
Default Value: true
API Name: spool_directory_usage_enabled
Required: false

Ranger Plugin Spool Directory Usage Thresholds for Impala Daemon

Description: The health test thresholds for monitoring the the Ranger Plugin Spool directory usage.
Related Name
Default Value: 1 GiB
API Name: spool_directory_usage_threshold
Required: false

Unexpected Exits Thresholds

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

Unexpected Exits Monitoring Period

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

Other

Impala Daemon Data Cache Per Directory Capacity

Description: Maximum amount of local disk space Impala will use per daemon in each of the configured directrories for caching of remote read data.
Related Name
Default Value
API Name: datacache_capacity
Required: false

Impala Daemon Data Cache Directories

Description: Directories Impala Daemon will use for caching of remote read data.
Related Name
Default Value
API Name: datacache_dirs
Required: false

Enable Local Data Cache

Description: Enable the local Impala Daemon data cache for caching of remote reads.
Related Name
Default Value: false
API Name: datacache_enabled
Required: false

Default File Format

Description: Default file format for CREATE TABLE statement.
Related Name: default_file_format
Default Value: parquet
API Name: default_file_format
Required: true

Impala Daemon Default Query Options

Description: A list of key-value pairs of additional query options to pass to the Impala Daemon command line, separated by ','.
Related Name: default_query_options
Default Value
API Name: default_query_options
Required: false

Default Table Format

Description: Whether tables should be created as ACID insert-only by default. Does not apply to external tables.
Related Name: default_transactional_type
Default Value: insert_only
API Name: default_transactional_type
Required: true

Impala Graceful Shutdown Deadline

Description: Deadline (in seconds) for the graceful shutdown process of Impala Daemons. Once this deadline is reached, the daemon shuts down regardless of any running queries. A value of 0 means immediate shutdown.
Related Name
Default Value: 1 minute(s)
API Name: impala_graceful_shutdown_deadline
Required: false

Impala Daemons Load Balancer

Description: Address of the load balancer used for Impala daemons. Should be specified in host:port format, where the port corresponds to the Beeswax protocol. If this is specified and Kerberos is enabled, Cloudera Manager adds a principal for 'impala/*load_balancer_host*@*realm*' to the keytab for all Impala daemons.
Related Name
Default Value
API Name: impalad_load_balancer
Required: false

Maximum Cached File Handles

Description: Maximum number of cached HDFS file handles. Caching HDFS file handles reduces the number of new file handles opened and thus reduces the load on the HDFS NameNode.. Each cached file handle consumes a small amount of memory on the Impala Daemon. If set to zero, the file handle caching is disabled.
Related Name: max_cached_file_handles
Default Value: 20000
API Name: impalad_max_cached_file_handles
Required: false

Impala Daemon Specialization

Description: Configures Impala daemons to only execute queries or perform query coordination. When this setting is in use, daemons specializing in both tasks must exist.
Related Name
Default Value: NO_SPECIALIZATION
API Name: impalad_specialization
Required: false

Unused Cached File Handle Timeout

Description: Maximum time, in seconds, that an unused HDFS file handle will remain in the HDFS file handle cache. When the underlying file for a cached file handle is deleted, the disk space may not be freed until the cached file handle is removed from the cache. Specifying this timeout allows the disk space of deleted files to be freed in a predictable period of time. If set to zero, unused cached HDFS file handles do not time out.
Related Name: unused_file_handle_timeout_sec
Default Value: 21600
API Name: impalad_unused_file_handle_timeout_sec
Required: false

Local UDF Library Dir

Description: User-defined function (UDF) libraries are copied from HDFS into this local directory.
Related Name: local_library_dir
Default Value: /var/lib/impala/udfs
API Name: local_library_dir
Required: false

Impala Daemon Scratch Directories

Description: Directories where Impala Daemon will write data such as spilling information to disk to free up memory. This can potentially be large amounts of data.
Related Name: scratch_dirs
Default Value
API Name: scratch_dirs
Required: false

Impala Shutdown Grace Period

Description: When the shutdown process is started for this daemon, it will wait for at least the startup grace period before shutting down. This gives time for updated cluster membership information to propagate to all coordinators and for fragment instances that were scheduled based on old cluster membership to start executing (and therefore be reflected in the metrics used to detect quiescence)
Related Name: shutdown_grace_period_s
Default Value: 2 minute(s)
API Name: shutdown_grace_period_s
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

Impala Daemon Backend Port

Description: Port on which thrift-based ImpalaInternalService is exported.
Related Name: be_port
Default Value: 22000
API Name: be_port
Required: false

Impala Daemon Beeswax Port

Description: Port on which Beeswax client requests are served by Impala Daemons.
Related Name: beeswax_port
Default Value: 21000
API Name: beeswax_port
Required: false

Impala Daemon HiveServer2 HTTP Port

Description: Port on which HiveServer2 client requests are served by Impala Daemons via HTTP.
Related Name: hs2_http_port
Default Value: 28000
API Name: hs2_http_port
Required: false

Impala Daemon HiveServer2 Port

Description: Port on which HiveServer2 client requests are served by Impala Daemons via the thrift binary protocol.
Related Name: hs2_port
Default Value: 21050
API Name: hs2_port
Required: false

Impala Daemons Load Balancer Hiveserver2 Port

Description: The load balancer port corresponding to the Hiveserver2 protocol.
Related Name
Default Value: 0
API Name: impala_load_balancer_hs2_port
Required: false

Enable Impala Daemon Web Server

Description: Enable or disable the Impala Daemon web server. This web server contains useful information about Impala Daemon.
Related Name: enable_webserver
Default Value: true
API Name: impalad_enable_webserver
Required: false

Impala Daemon HTTP Server Port

Description: Port where Impala debug web server runs.
Related Name: webserver_port
Default Value: 25000
API Name: impalad_webserver_port
Required: false

Impala Daemon KRPC Port

Description: Port on which KRPC-based ImpalaInternalService is exported.
Related Name: krpc_port
Default Value: 27000
API Name: krpc_port
Required: false

Llama Callback Port

Description: Port where Llama notification callback should be started
Related Name: llama_callback_port
Default Value: 0
API Name: llama_callback_port
Required: false

Second Statestore Host Name

Description: The hostname of the second statestore instance. Valid when statestore HA enabled.
Related Name: state_store_2_host
Default Value
API Name: state_store_2_host
Required: false

Second Statestore Port

Description: The port of statestore service running on the second statestore instance. Valid when statestore HA enabled.
Related Name: state_store_2_port
Default Value: 24000
API Name: state_store_2_port
Required: false

Statestore Host Name

Description: The hostname of the statestore instance. When statestore HA is enabled, this stands for the first statestore instance.
Related Name: state_store_host
Default Value
API Name: state_store_host
Required: false

Statestore Port

Description: The port of statestore service running on the statestore instance. When statestore HA is enabled, this stands for the first statestore instance.
Related Name: state_store_port
Default Value: 24000
API Name: state_store_port
Required: false

StateStoreSubscriber Service Port

Description: Port where StateStoreSubscriberService is running.
Related Name: state_store_subscriber_port
Default Value: 23000
API Name: state_store_subscriber_port
Required: false

Resource Management

Java Heap Size of Impala Daemon in Bytes

Description: Maximum size in bytes for the Java Process heap memory. Passed to Java -Xmx.
Related Name: Impala Daemon JVM Heap
Default Value: 4 GiB
API Name: impalad_embedded_jvm_heapsize
Required: false

Idle Query Timeout

Description: The time that a query may be idle (i.e. no processing work is done and no updates are received from the client) before it is cancelled. If 0, idle queries are never expired.
Related Name: idle_query_timeout
Default Value: 0 second(s)
API Name: impalad_idle_query_timeout
Required: false

Idle Session Timeout

Description: The time that a session may be idle before it is closed (and all running queries cancelled) by Impala. If 0, idle sessions are never expired.
Related Name: idle_session_timeout
Default Value: 0 second(s)
API Name: impalad_idle_session_timeout
Required: false

Impala Daemon Memory Limit

Description: Memory limit for Impala Daemon, enforced by the daemon itself. This limit does not include memory consumed by the daemon's embedded JVM. The Impala Daemon uses up to this amount of memory for query processing, cached data, network buffers, background operations, etc. If exceeded, queries running on the Impala Daemon will be killed until the Impala Daemon is under the memory limit.
Related Name: mem_limit
Default Value
API Name: impalad_memory_limit
Required: false

Cgroup V1 BLKIO Weight

Description: Weight for the read I/O requests issued by this role, enforced by the Linux kernel under cgroup v1. 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_blkio_weight
Required: true

Cgroup V1 CPU Shares

Description: Number of CPU shares to assign to this role, enforced by the Linux kernel under cgroup v1. 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

Cgroup V2 CPU Weight

Description: Weight of CPU resources to assign to this role, enforced by the Linux kernel under cgroup v2. The greater the weight, 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 1 and 10000. Defaults to 100.
Related Name: cpu.weight
Default Value: 100
API Name: rm_cpu_weight
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 V2 I/O Weight

Description: Weight for the I/O requests issued by this role, enforced by the Linux kernel under cgroup v2. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 1 and 10000. Defaults to 100.
Related Name: io.weight
Default Value: 100
API Name: rm_io_weight
Required: true

Cgroup V1 Memory Hard Limit

Description: Hard memory limit to assign to this role, enforced by the Linux kernel under cgroup v1. 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_v1
Required: true

Cgroup V2 Memory Hard Limit

Description: Hard memory limit to assign to this role, enforced by the Linux kernel under cgroup v2. 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 and page cache pages contribute to the limit. Use a value of 'max' to specify no limit. By default, processes not managed by Cloudera Manager will have no limit. If the value is 'max', Cloudera Manager will not monitor Cgroup memory usage, and some charts will show 'No Data'.
Related Name: memory.max
Default Value: -1 MiB
API Name: rm_memory_hard_limit_v2
Required: true

Cgroup V1 Memory Soft Limit

Description: Soft memory limit to assign to this role, enforced by the Linux kernel under cgroup v1. 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_v1
Required: true

Cgroup V2 Memory Soft Limit

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

Security

Disk Spill Encryption

Description: Encrypt and verify the integrity of all data spilled to disk as part of a query. This feature is only supported for Impala 2.0 and higher and CDH 5.2 and higher (which includes Impala 2.0).
Related Name: disk_spill_encryption
Default Value: false
API Name: disk_spill_encryption
Required: false

LDAP Server CA Certificate

Description: The location on disk of the certificate, in .pem format, used to confirm the authenticity of the LDAP server certificate. This is the Certificate Authority (CA) certificate, and it was used to sign the LDAP server certificate. If not set, all certificates are trusted, which means that an attacker could potentially intercept otherwise encrypted usernames and passwords.
Related Name: ldap_ca_certificate
Default Value
API Name: impalad_ldap_ca_certificate
Required: false

JWKS Pull Timeout

Description: The time in seconds to wait for the JWKS to be downloaded from the specified URL before timing out.
Related Name: jwks_pulling_timeout_s
Default Value: 10 second(s)
API Name: jwks_pulling_timeout_s
Required: false

JWKS Update Frequency

Description: The time in seconds to wait between re-downloading the JWKS from the specified URL.
Related Name: jwks_update_frequency_s
Default Value: 10 second(s)
API Name: jwks_update_frequency_s
Required: false

JWKS URL

Description: URL where the JSON Web Key Set (JWKS) can be downloaded for JWT verification.
Related Name: jwks_url
Default Value
API Name: jwks_url
Required: false

Verify JWKS Server Certificate

Description: Specifies if the TLS certificate of the JWKS server is verified when retrieving the JWKS from the specified JWKS URL. This should only be set to false for development / testing.
Related Name: jwks_verify_server_certificate
Default Value: true
API Name: jwks_verify_server_certificate
Required: false

JWT Allow Without TLS

Description: Determines if JWT authentication is allowed without TLS being enabled on connections to the Impala daemon.
Related Name: jwt_allow_without_tls
Default Value: false
API Name: jwt_allow_without_tls
Required: false

Username JWT Custom Claim

Description: JWT claim that contains the username to use when authenticating with Impala.
Related Name: jwt_custom_claim_username
Default Value
API Name: jwt_custom_claim_username
Required: false

JWT Token Authentication

Description: Determines if JWT token authentication is enabled.
Related Name: jwt_token_auth
Default Value: false
API Name: jwt_token_auth
Required: false

JWT Validate Signature

Description: Determines if the signatures on incoming JWTs are validated against the JWKS.
Related Name: jwt_validate_signature
Default Value: true
API Name: jwt_validate_signature
Required: false

Impala Daemon Webserver 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 Impala Daemon Webserver is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name: webserver_certificate_file
Default Value
API Name: webserver_certificate_file
Required: false

Impala Daemon Web Server User Password

Description: Password for Impala Daemon webserver authentication.
Related Name: webserver_htpassword_password
Default Value
API Name: webserver_htpassword_password
Required: false

Impala Daemon Web Server Username

Description: Username for Impala Daemon webserver authentication.
Related Name: webserver_htpassword_user
Default Value
API Name: webserver_htpassword_user
Required: false

Impala Daemon Webserver 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 Impala Daemon Webserver 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: webserver_private_key_file
Required: false

Impala Daemon Webserver TLS/SSL Private Key Password

Description: The password for the private key in the Impala Daemon Webserver 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: webserver_private_key_password_cmd
Required: false

Stacks Collection

Stacks Collection Data Retention

Description: The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
Related Name: stacks_collection_data_retention
Default Value: 100 MiB
API Name: stacks_collection_data_retention
Required: false

Stacks Collection Directory

Description: The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race.
Related Name: stacks_collection_directory
Default Value
API Name: stacks_collection_directory
Required: false

Stacks Collection Enabled

Description: Whether or not periodic stacks collection is enabled.
Related Name: stacks_collection_enabled
Default Value: false
API Name: stacks_collection_enabled
Required: true

Stacks Collection Frequency

Description: The frequency with which stacks are collected.
Related Name: stacks_collection_frequency
Default Value: 5.0 second(s)
API Name: stacks_collection_frequency
Required: false

Stacks Collection Method

Description: The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped.
Related Name: stacks_collection_method
Default Value: jstack
API Name: stacks_collection_method
Required: false

Suppressions

Suppress Parameter Validation: Impala Daemon Audit Log Directory

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

Suppress Parameter Validation: Impala Daemon Backend Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemon Backend Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_be_port
Required: true

Suppress Parameter Validation: Impala Daemon Beeswax Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemon Beeswax Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_beeswax_port
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: Impala Daemon Core Dump Directory

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

Suppress Parameter Validation: Impala Daemon Data Cache Directories

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemon Data Cache Directories parameter.
Related Name
Default Value: false
API Name: role_config_suppression_datacache_dirs
Required: true

Suppress Configuration Validator: Impala Daemon Default Memory Limit Validator

Description: Whether to suppress configuration warnings produced by the Impala Daemon Default Memory Limit Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_default_impalad_memory_limit_validator
Required: true

Suppress Parameter Validation: Impala Daemon Default Query Options

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemon Default Query Options parameter.
Related Name
Default Value: false
API Name: role_config_suppression_default_query_options
Required: true

Suppress Parameter Validation: Impala Daemon HiveServer2 HTTP Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemon HiveServer2 HTTP Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hs2_http_port
Required: true

Suppress Parameter Validation: Impala Daemon HiveServer2 Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemon HiveServer2 Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hs2_port
Required: true

Suppress Configuration Validator: Impala Audit Enabled Validator

Description: Whether to suppress configuration warnings produced by the Impala Audit Enabled Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impala_audit_enabled_validator
Required: true

Suppress Parameter Validation: Impala Daemon HDFS Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: Impala Daemon Hive Advanced Configuration Snippet (Safety Valve)

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

Suppress Configuration Validator: Impala Lineage Enabled Validator

Description: Whether to suppress configuration warnings produced by the Impala Lineage Enabled Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impala_lineage_enabled_validator
Required: true

Suppress Parameter Validation: Impala Daemon Llama Site Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: Impala Daemons Load Balancer Hiveserver2 Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemons Load Balancer Hiveserver2 Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_impala_load_balancer_hs2_port
Required: true

Suppress Parameter Validation: Impala Daemon Command Line Argument Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemon Command Line Argument Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_cmd_args_safety_valve
Required: true

Suppress Configuration Validator: Impala Daemon Command Line Arguments Safety Valve Validator

Description: Whether to suppress configuration warnings produced by the Impala Daemon Command Line Arguments Safety Valve Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_cmd_args_safety_valve_validator
Required: true

Suppress Parameter Validation: Impala Daemon Advanced Configuration Snippet (Safety Valve) for core-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemon Advanced Configuration Snippet (Safety Valve) for core-site.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_core_site_safety_valve
Required: true

Suppress Parameter Validation: Java Configuration Options for Impala Daemon

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Configuration Options for Impala Daemon parameter.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_embedded_java_opts
Required: true

Suppress Parameter Validation: Impala Daemon Fair Scheduler Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: Impala Daemon HBase Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: LDAP Server CA Certificate

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Server CA Certificate parameter.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_ldap_ca_certificate
Required: true

Suppress Parameter Validation: Impala Daemons Load Balancer

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemons Load Balancer parameter.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_load_balancer
Required: true

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

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

Suppress Parameter Validation: Impala Daemon HTTP Server Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemon HTTP Server Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_webserver_port
Required: true

Suppress Parameter Validation: JMX Exporter configuration YAML

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter configuration YAML parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_yaml
Required: true

Suppress Parameter Validation: JWKS URL

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

Suppress Parameter Validation: Username JWT Custom Claim

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Username JWT Custom Claim parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jwt_custom_claim_username
Required: true

Suppress Parameter Validation: Impala Daemon KRPC Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemon KRPC Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_krpc_port
Required: true

Suppress Parameter Validation: Impala Daemon Lineage Log Directory

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

Suppress Parameter Validation: Llama Callback Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Llama Callback Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_llama_callback_port
Required: true

Suppress Parameter Validation: Local UDF Library Dir

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Local UDF Library Dir parameter.
Related Name
Default Value: false
API Name: role_config_suppression_local_library_dir
Required: true

Suppress Parameter Validation: Impala Daemon Logging Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: Impala Daemon Log Directory

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

Suppress Parameter Validation: Impala Daemon Breakpad Dump Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemon Breakpad Dump Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_minidump_path
Required: true

Suppress Parameter Validation: Heap Dump Directory

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

Suppress Parameter Validation: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Helper Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Helper Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_helper_port
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_exporters
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_extensions
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_processors
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_receivers
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_service
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
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: Impala Daemon Scratch Directories

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemon Scratch Directories parameter.
Related Name
Default Value: false
API Name: role_config_suppression_scratch_dirs
Required: true

Suppress Parameter Validation: Stacks Collection Directory

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

Suppress Parameter Validation: Second Statestore Host Name

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Second Statestore Host Name parameter.
Related Name
Default Value: false
API Name: role_config_suppression_state_store_2_host
Required: true

Suppress Parameter Validation: Statestore Host Name

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

Suppress Parameter Validation: StateStoreSubscriber Service Port

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

Suppress Configuration Validator: Impala Daemon Unlimited Memory Limit Validator

Description: Whether to suppress configuration warnings produced by the Impala Daemon Unlimited Memory Limit Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_unlimited_impalad_memory_limit_validator
Required: true

Suppress Parameter Validation: Impala Daemon Webserver TLS/SSL Server Certificate File (PEM Format)

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

Suppress Parameter Validation: Impala Daemon Web Server User Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemon Web Server User Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_htpassword_password
Required: true

Suppress Parameter Validation: Impala Daemon Web Server Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemon Web Server Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_htpassword_user
Required: true

Suppress Parameter Validation: Impala Daemon Webserver TLS/SSL Server Private Key File (PEM Format)

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

Suppress Parameter Validation: Impala Daemon Webserver TLS/SSL Private Key Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Daemon Webserver TLS/SSL Private Key Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_private_key_password_cmd
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_impalad_audit_health
Required: true

Suppress Health Test: StateStore Connectivity

Description: Whether to suppress the results of the StateStore Connectivity 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_impalad_connectivity
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_impalad_file_descriptor
Required: true

Suppress Health Test: Impala Concurrent Client Connections

Description: Whether to suppress the results of the Impala Concurrent Client Connections 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_impalad_frontend_connections
Required: true

Suppress Health Test: Heap Dump Directory Free Space

Description: Whether to suppress the results of the Heap Dump 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_impalad_heap_dump_directory_free_space
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_impalad_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_impalad_log_directory_free_space
Required: true

Suppress Health Test: Resident Set Size

Description: Whether to suppress the results of the Resident Set Size 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_impalad_memory_rss_health
Required: true

Suppress Health Test: Otelcol Health

Description: Whether to suppress the results of the Otelcol 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_impalad_otelcol_health
Required: true

Suppress Health Test: Pause Duration

Description: Whether to suppress the results of the Pause Duration 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_impalad_pause_duration
Required: true

Suppress Health Test: Query Monitoring Status Check

Description: Whether to suppress the results of the Query Monitoring Status Check 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_impalad_query_monitoring_status
Required: true

Suppress Health Test: Ranger Plugin Hdfs Spool Directory Size

Description: Whether to suppress the results of the Ranger Plugin Hdfs Spool Directory Size 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_impalad_ranger_plugin_hdfs_spool_directory_size_health
Required: true

Suppress Health Test: Ranger Plugin Solr Spool Directory Size

Description: Whether to suppress the results of the Ranger Plugin Solr Spool Directory Size 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_impalad_ranger_plugin_solr_spool_directory_size_health
Required: true

Suppress Health Test: Impala Daemon Ready Check

Description: Whether to suppress the results of the Impala Daemon Ready Check 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_impalad_ready_status
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_impalad_scm_health
Required: true

Suppress Health Test: Impala Daemon Scratch Directories Free Space

Description: Whether to suppress the results of the Impala Daemon Scratch Directories 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_impalad_scratch_directories_free_space
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_impalad_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_impalad_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_impalad_unexpected_exits
Required: true

Suppress Health Test: Web Server Status

Description: Whether to suppress the results of the Web Server 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_impalad_web_metric_collection
Required: true

Impala StateStore

Advanced

StateStore Core Dump Directory

Description: Directory where a StateStore core dump is placed.
Related Name: core_dump_dir
Default Value: /var/log/statestore
API Name: core_dump_dir
Required: false

Statestore Max Breakpad Dump Files

Description: Maximum number of Breakpad dump files stored by Statestore Role.
Related Name: max_minidumps
Default Value: 9
API Name: max_minidumps
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

Statestore Breakpad Dump Directory

Description: Directory for storing Statestore Breakpad dumps.
Related Name: minidump_path
Default Value: /var/log/impala-minidumps
API Name: minidump_path
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: true
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

Statestore Command Line Argument Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, key-value pairs (one on each line) to be added (verbatim) to StateStore command line flags.
Related Name
Default Value
API Name: statestore_cmd_args_safety_valve
Required: false

Impala StateStore 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: STATESTORE_role_env_safety_valve
Required: false

Logs

StateStore Log Directory

Description: Directory where StateStore will place its log files.
Related Name: log_dir
Default Value: /var/log/statestore
API Name: log_dir
Required: false

Impala StateStore Logging Threshold

Description: The minimum log level for Impala StateStore logs
Related Name
Default Value: INFO
API Name: log_threshold
Required: false

StateStore Verbose Log Level

Description: Verbose logging level for the GLog logger. These messages are always logged at 'INFO' log level, so this setting has no effect if Logging Threshold is set to 'WARN' or above.
Related Name: GLOG_v
Default Value: 1
API Name: log_verbose_level
Required: false

StateStore Log Buffer Level

Description: Buffer log messages logged at this level or lower (-1 means don't buffer; 0 means buffer INFO only; 1 means buffer WARNING only, ...)
Related Name: logbuflevel
Default Value: 0
API Name: logbuflevel
Required: false

StateStore Maximum Log Files

Description: The number of log files that are kept for each severity level before all older log files are removed. The number has to be greater than 1 to keep at least the current log file open. If set to 0, all log files are retained and log rotation is effectively disabled.
Related Name: max_log_files
Default Value: 10
API Name: max_log_files
Required: false

Impala StateStore Max Log Size

Description: The maximum size, in megabytes, per log file for Impala StateStore logs. Typically used by log4j or logback.
Related Name
Default Value: 200 MiB
API Name: max_log_size
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

Heap Dump Directory Free Space Monitoring Absolute Thresholds

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

Heap Dump Directory Free Space Monitoring Percentage Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Heap Dump Directory Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: heap_dump_directory_free_space_percentage_thresholds
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

Navigator Audit Failure Thresholds

Description: The health test thresholds for failures encountered when monitoring audits within a recent period specified by the mgmt_navigator_failure_window configuration for the role. The value that can be specified for this threshold is the number of bytes of audits data that is left to be sent to audit server.
Related Name: mgmt.navigator.failure.thresholds
Default Value: Warning: Never, Critical: Any
API Name: mgmt_navigator_failure_thresholds
Required: false

Monitoring Period For Audit Failures

Description: The period to review when checking if audits are blocked and not getting processed.
Related Name: mgmt.navigator.failure.window
Default Value: 20 minute(s)
API Name: mgmt_navigator_failure_window
Required: false

Navigator Audit Pipeline Health Check

Description: Enable test of audit events processing pipeline. This will test if audit events are not getting processed by Audit Server for a role that generates audit.
Related Name: mgmt.navigator.status.check.enabled
Default Value: true
API Name: mgmt_navigator_status_check_enabled
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

OpenTelemetry Collector Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: exporters: prometheusremotewrite/$ROLE_NAME: endpoint: $ROLE_PARAM(otelcol_remote_write_url) auth: authenticator: basicauth/$ROLE_NAME tls: insecure_skip_verify: true retry_on_failure: enabled: true initial_interval: 10s max_interval: 40s max_elapsed_time: 300s
API Name: otelcol_exporters
Required: false

OpenTelemetry Collector Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: extensions: basicauth/$ROLE_NAME: client_auth: username: $ROLE_PARAM(otelcol_remote_write_user) password: '$ROLE_PARAM(otelcol_remote_write_password)' spnegoauth/$ROLE_NAME: enabled: $ROLE_BOOLEAN_PARAM(hadoop_secure_web_ui, true, false) realm: '$KRB_REALM' principal: 'HTTP/$HOST_NAME' krb5_conf_path: '$KRB_CONF_PATH' keytab_path: $TARGET_PROC_DIR/impala.keytab http_forwarder/$ROLE_NAME: ingress: endpoint: localhost:$ROLE_PARAM(otelcol_helper_port) egress: endpoint: $ROLE_BOOLEAN_PARAM(client_services_ssl_enabled, https, http)://$HOST_NAME:$ROLE_PARAM(statestore_webserver_port)/ auth: authenticator: spnegoauth/$ROLE_NAME tls: insecure_skip_verify: true headers: otel_http_forwarder: dev timeout: 5s
API Name: otelcol_extensions
Required: false

OpenTelemetry Collector Helper Port

Description: This port can be used for JMX Exporter to implement a Prometheus exporter or for other OpenTelemetry Collector related purposes
Related Name
Default Value: 11152
API Name: otelcol_helper_port
Required: false

OpenTelemetry Collector Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: processors: filter/$ROLE_NAME: metrics: include: match_type: strict metric_names: - impala_rpc_method_statestore_StatestoreService_RegisterSubscriber_call_duration - impala_thrift_server_StatestoreService_timedout_cnxn_requests - impala_thrift_server_StatestoreService_total_connections - impala_thrift_server_StatestoreService_connections_in_use - impala_subscriber_heartbeat_client_cache_clients_in_use - impala_tcmalloc_pageheap_unmapped_bytes - impala_tcmalloc_pageheap_free_bytes - impala_statestore_live_backends
API Name: otelcol_processors
Required: false

OpenTelemetry Collector Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value: receivers: prometheus/$ROLE_NAME: config: scrape_configs: - job_name: 'DMP-$ROLE_NAME' scrape_interval: 60s scheme: http metrics_path: '/metrics_prometheus' tls_config: insecure_skip_verify: true static_configs: - targets: ['localhost:$ROLE_PARAM(otelcol_helper_port)'] labels: host_name: $HOST_NAME cm_cluster_id: $CLUSTER_ID service_type: $SERVICE_TYPE service: $SERVICE_NAME role_type: $ROLE_TYPE role_name: $ROLE_NAME instance: $INFRA(instance_id) cluster_id: $INFRA(cluster_id) platform: $INFRA(platform) formfactor: paas-vm relabel_configs: - source_labels: [cluster_id] regex: 'crn:cdp:([^:]+):.*' replacement: '$$1' target_label: app_type action: replace
API Name: otelcol_receivers
Required: false

OpenTelemetry Collector Remote Write Password

Description: Remote write password for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_password) expression. Specify $INFRA(cdp_request_signer_password) when forwarding to Cloudera Observability central monitoring. (This is the default.)
Related Name
Default Value: ******
API Name: otelcol_remote_write_password
Required: false

OpenTelemetry Collector Remote Write URL

Description: Remote write URL for the OpenTelemetry Collector. This param is for convenience and intended to be used at the exporters section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_url) expression. Specify $INFRA(cdp_request_signer_url) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_url)
API Name: otelcol_remote_write_url
Required: false

OpenTelemetry Collector Remote Write Username

Description: Remote write username for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_user) expression. Specify $INFRA(cdp_request_signer_username) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_username)
API Name: otelcol_remote_write_user
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_rtm_logs_exporters
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_rtm_logs_extensions
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_rtm_logs_processors
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value
API Name: otelcol_rtm_logs_receivers
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_rtm_logs_service
Required: false

OpenTelemetry Collector Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: service: pipelines: metrics/$ROLE_NAME: receivers: [prometheus/$ROLE_NAME] processors: [filter/$ROLE_NAME] exporters: [prometheusremotewrite/$ROLE_NAME]
API Name: otelcol_service
Required: false

Enable OpenTelemetry Collector (beta)

Description: OpenTelemetry Collector support is a new beta feature (will change without notice) which can run OpenTelemetry Collector as an agent together with the CM Agent to forward metrics to a Prometheus like storage.
Related Name
Default Value: true
API Name: otelcol_should_collect
Required: true

Enable Real-Time Monitoring for Jobs / Queries with OpenTelemetry

Description: This enables OpenTelemetry Collector as an agent together with the CM Agent to forward real-time monitoring data about jobs / queries to Observability backend. The configuration of the subsections shouldn't be modified manually.
Related Name
Default Value: false
API Name: otelcol_should_collect_rtm_logs
Required: true

Resident Set Size Thresholds

Description: The health test thresholds on the resident size of the process.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_resident_set_size_thresholds
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

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: statestore_fd_thresholds
Required: false

Impala StateStore Host Health Test

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

Impala StateStore Process Health Test

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

Health Test Startup Tolerance

Description: The amount of time allowed after this role is started that failures of health tests that rely on communication with this role will be tolerated.
Related Name
Default Value: 5 minute(s)
API Name: statestore_startup_tolerance
Required: false

Web Metric Collection

Description: Enables the health test that the Cloudera Manager Agent can successfully contact and gather metrics from the web server.
Related Name
Default Value: true
API Name: statestore_web_metric_collection_enabled
Required: false

Web Metric Collection Duration

Description: The health test thresholds on the duration of the metrics request to the web server.
Related Name
Default Value: Warning: 10 second(s), Critical: Never
API Name: statestore_web_metric_collection_thresholds
Required: false

Unexpected Exits Thresholds

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

Unexpected Exits Monitoring Period

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

Other

Catalog HA Preemption Wait Period

Description: Wait period before choosing the primary catalog server.
Related Name: catalogd_ha_preemption_wait_period_ms
Default Value: 10 second(s)
API Name: statestore_catalogd_ha_preemption_wait_period_ms
Required: false

Enable StateStore Web Server

Description: Enable/Disable StateStore web server. This web server contains useful information about StateStore daemon.
Related Name: enable_webserver
Default Value: true
API Name: statestore_enable_webserver
Required: false

Force the Statestore active

Description: Set to true to force the statestored instance to take active role. Valid when statestore HA enabled.
Related Name: statestore_force_active
Default Value: false
API Name: statestore_force_active
Required: false

Statestore HA Preemption Wait Period

Description: The time after which statestored designates itself in active role if the statestore does not receive negotiation request from its peer statestore during start up.
Related Name: statestore_ha_preemption_wait_period_ms
Default Value: 10 second(s)
API Name: statestore_ha_preemption_wait_period_ms
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

StateStore Worker Threads

Description: Number of worker threads for the thread manager underlying the StateStore Thrift server.
Related Name: state_store_num_server_worker_threads
Default Value: 4
API Name: state_store_num_server_worker_threads
Required: false

Maximum StateStore Pending Tasks

Description: Maximum number of tasks allowed to be pending at the thread manager underlying the StateStore Thrift server (0 allows infinitely many pending tasks)
Related Name: state_store_pending_task_count_max
Default Value: 0
API Name: state_store_pending_task_count_max
Required: false

Ports and Addresses

Statestore HA Port

Description: The port of Thrift service for communication between two statestore instances in HA pair. Valid when statestore HA enabled.
Related Name: state_store_ha_port
Default Value: 24020
API Name: state_store_ha_port
Required: false

Peer Statestore Port

Description: The port of Thrift service of peer statestore instance for statestore HA. Valid when statestore HA enabled.
Related Name: state_store_peer_ha_port
Default Value: 24020
API Name: state_store_peer_ha_port
Required: false

Peer Statestore Host Name

Description: The hostname of peer statesore instance in HA pair. Valid when statestore HA enabled.
Related Name: state_store_peer_host
Default Value
API Name: state_store_peer_host
Required: false

StateStore Service Port

Description: Port where StateStoreService is exported.
Related Name: state_store_port
Default Value: 24000
API Name: state_store_port
Required: false

StateStore HTTP Server Port

Description: Port where StateStore debug web server runs.
Related Name: webserver_port
Default Value: 25010
API Name: statestore_webserver_port
Required: false

Resource Management

Cgroup V1 BLKIO Weight

Description: Weight for the read I/O requests issued by this role, enforced by the Linux kernel under cgroup v1. 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_blkio_weight
Required: true

Cgroup V1 CPU Shares

Description: Number of CPU shares to assign to this role, enforced by the Linux kernel under cgroup v1. 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

Cgroup V2 CPU Weight

Description: Weight of CPU resources to assign to this role, enforced by the Linux kernel under cgroup v2. The greater the weight, 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 1 and 10000. Defaults to 100.
Related Name: cpu.weight
Default Value: 100
API Name: rm_cpu_weight
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 V2 I/O Weight

Description: Weight for the I/O requests issued by this role, enforced by the Linux kernel under cgroup v2. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 1 and 10000. Defaults to 100.
Related Name: io.weight
Default Value: 100
API Name: rm_io_weight
Required: true

Cgroup V1 Memory Hard Limit

Description: Hard memory limit to assign to this role, enforced by the Linux kernel under cgroup v1. 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_v1
Required: true

Cgroup V2 Memory Hard Limit

Description: Hard memory limit to assign to this role, enforced by the Linux kernel under cgroup v2. 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 and page cache pages contribute to the limit. Use a value of 'max' to specify no limit. By default, processes not managed by Cloudera Manager will have no limit. If the value is 'max', Cloudera Manager will not monitor Cgroup memory usage, and some charts will show 'No Data'.
Related Name: memory.max
Default Value: -1 MiB
API Name: rm_memory_hard_limit_v2
Required: true

Cgroup V1 Memory Soft Limit

Description: Soft memory limit to assign to this role, enforced by the Linux kernel under cgroup v1. 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_v1
Required: true

Cgroup V2 Memory Soft Limit

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

Security

StateStore Webserver 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 StateStore Webserver is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name: webserver_certificate_file
Default Value
API Name: webserver_certificate_file
Required: false

Statestore Web Server User Password

Description: Password for Statestore webserver authentication.
Related Name: webserver_htpassword_password
Default Value
API Name: webserver_htpassword_password
Required: false

Statestore Web Server Username

Description: Username for Statestore webserver authentication.
Related Name: webserver_htpassword_user
Default Value
API Name: webserver_htpassword_user
Required: false

StateStore Webserver 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 StateStore Webserver 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: webserver_private_key_file
Required: false

StateStore Webserver TLS/SSL Private Key Password

Description: The password for the private key in the StateStore Webserver 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: webserver_private_key_password_cmd
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: StateStore Core Dump Directory

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

Suppress Parameter Validation: StateStore Log Directory

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

Suppress Parameter Validation: Statestore Breakpad Dump Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Statestore Breakpad Dump Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_minidump_path
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Helper Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Helper Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_helper_port
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_exporters
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_extensions
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_processors
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_receivers
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_service
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
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: Statestore HA Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Statestore HA Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_state_store_ha_port
Required: true

Suppress Parameter Validation: Peer Statestore Host Name

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Peer Statestore Host Name parameter.
Related Name
Default Value: false
API Name: role_config_suppression_state_store_peer_host
Required: true

Suppress Parameter Validation: StateStore Service Port

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

Suppress Parameter Validation: Statestore Command Line Argument Advanced Configuration Snippet (Safety Valve)

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

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

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

Suppress Parameter Validation: StateStore HTTP Server Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the StateStore HTTP Server Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_statestore_webserver_port
Required: true

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

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

Suppress Parameter Validation: Statestore Web Server User Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Statestore Web Server User Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_htpassword_password
Required: true

Suppress Parameter Validation: Statestore Web Server Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Statestore Web Server Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_htpassword_user
Required: true

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

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

Suppress Parameter Validation: StateStore Webserver TLS/SSL Private Key Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the StateStore Webserver TLS/SSL Private Key Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_private_key_password_cmd
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_statestore_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_statestore_file_descriptor
Required: true

Suppress Health Test: Heap Dump Directory Free Space

Description: Whether to suppress the results of the Heap Dump 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_statestore_heap_dump_directory_free_space
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_statestore_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_statestore_log_directory_free_space
Required: true

Suppress Health Test: Resident Set Size

Description: Whether to suppress the results of the Resident Set Size 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_statestore_memory_rss_health
Required: true

Suppress Health Test: Otelcol Health

Description: Whether to suppress the results of the Otelcol 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_statestore_otelcol_health
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_statestore_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_statestore_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_statestore_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_statestore_unexpected_exits
Required: true

Suppress Health Test: Web Server Status

Description: Whether to suppress the results of the Web Server 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_statestore_web_metric_collection
Required: true

Service-Wide

Admission Control

Enable Dynamic Resource Pools

Description: Use Dynamic Resource Pools to configure Impala admission control or RM for this Impala service. These features are only supported in Impala 1.3 or higher deployments.
Related Name
Default Value: true
API Name: admission_control_enabled
Required: false

Admission Control Queue Timeout

Description: Maximum amount of time (in milliseconds) that a request waits to be admitted before timing out. Must be a positive integer.
Related Name: queue_wait_timeout_ms
Default Value: 1 minute(s)
API Name: admission_control_queue_timeout
Required: false

Single Pool Max Queued Queries

Description: Configures the maximum number of queued queries for admission control when using a single pool. -1 or 0 disables queuing, i.e. incoming requests are rejected if they can not be executed immediately. Ignored when Dynamic Resource Pools for Admission Control is enabled.
Related Name: default_pool_max_queued
Default Value: 200
API Name: admission_control_single_pool_max_queued
Required: false

Single Pool Max Running Queries

Description: Configures the maximum number of concurrently running queries for admission control when using a single pool. -1 indicates no limit and 0 indicates all incoming requests will be rejected. Ignored when Dynamic Resource Pools for Admission Control is enabled.
Related Name: default_pool_max_requests
Default Value: 200
API Name: admission_control_single_pool_max_requests
Required: false

Single Pool Mem Limit

Description: Configures the max memory of running queries for admission control when using a single pool. -1 or 0 indicates no limit. Ignored when Dynamic Resource Pools for Admission Control is enabled.
Related Name: default_pool_mem_limit
Default Value: -1 B
API Name: admission_control_single_pool_mem_limit
Required: false

Enable Impala Admission Control

Description: Use Impala Admission Control to throttle Impala requests. Unless 'Enable Dynamic Resource Pools' is enabled, Impala uses a single, default pool that is configured using the Single Pool configurations below. These features are only supported in Impala 1.3 or higher deployments.
Related Name
Default Value: true
API Name: all_admission_control_enabled
Required: false

Advanced

Impala Service Advanced Configuration Snippet (Safety Valve) for atlas-application.properties

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

Enable Core Dump

Description: Used to generate a core dump to get more information about an Impala crash. Unless otherwise configured systemwide using /proc/sys/kernel/core_pattern, the dump is generated in the 'current directory' of the Impala process (usually a subdirectory of the /var/run/cloudera-scm-agent/process directory). The core file can be very large.
Related Name
Default Value: false
API Name: enable_core_dump
Required: false

Maximum HBase Client Retries

Description: Maximum number of HBase client retries for Impala. Used as a maximum for all operations such as fetching of the root region from the root RegionServer, getting a cell's value, and starting a row update. Overrides configuration in the HBase service.
Related Name: hbase.client.retries.number
Default Value: 3
API Name: hbase_client_retries_number
Required: false

HBase RPC Timeout

Description: Timeout in milliseconds for all HBase RPCs made by Impala. Overrides configuration in HBase service.
Related Name: hbase.rpc.timeout
Default Value: 3 second(s)
API Name: hbase_rpc_timeout
Required: false

Impala Command Line Argument Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, key-value pairs (one on each line) to be added (verbatim) to Impala Daemon command-line flags. Applies to all roles in this service. Key names should begin with a hyphen(-). For example: -log_filename=foo.log
Related Name
Default Value
API Name: impala_cmd_args_safety_valve
Required: false

Fair Scheduler Configuration Rules (Deployed)

Description: A list specifying the rules to run to determine which Fair Scheduler configuration to use. The value specified here is deployed to all hosts. This configuration has effect only on Impala versions 1.3 or greater.
Related Name
Default Value: []
API Name: impala_schedule_rules
Required: false

Fair Scheduler Configuration Rules (Staged)

Description: A list specifying the rules to run to determine which Fair Scheduler configuration to use. Typically edited using the Rules configuration UI. This configuration only has effect on Impala versions 1.3 or greater.
Related Name
Default Value
API Name: impala_schedule_rules_draft
Required: false

Fair Scheduler Allocations (Deployed)

Description: JSON representation of all the configurations that the Fair Scheduler can take across all schedules. This configuration has effect only on Impala versions 1.3 or greater.
Related Name
Default Value: queues: [ name: root, queues: [ name: default, queues: [], schedulablePropertiesList: [ scheduleName: default ] ], schedulablePropertiesList: [ scheduleName: default ] ], users: []
API Name: impala_scheduled_allocations
Required: false

Fair Scheduler Allocations (Staged)

Description: JSON representation of all the configurations that the Fair Scheduler can take across all schedules. Typically edited using the Pools configuration UI. This configuration only has effect on Impala versions 1.3 or greater.
Related Name
Default Value
API Name: impala_scheduled_allocations_draft
Required: false

Impala 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: impala_service_env_safety_valve
Required: false

Impala Service Advanced Configuration Snippet (Safety Valve) for sentry-site.xml

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

Use HDFS Rules to Map Kerberos Principals to Short Names

Description: If checked and Impala is using Kerberos, Impala will use the hadoop.security.auth_to_local rules from HDFS configuration. The relevant HDFS configuration is derived from Additional Rules to Map Kerberos Principals to Short Names.
Related Name: load_auth_to_local_rules
Default Value: false
API Name: load_hdfs_auth_to_local_rules
Required: false

Impala Client Advanced Configuration Snippet (Safety Valve) for navigator.client.properties

Description: For advanced use only, a string to be inserted into the client configuration for navigator.client.properties.
Related Name
Default Value
API Name: navigator_client_config_safety_valve
Required: false

Impala Client Advanced Configuration Snippet (Safety Valve) for navigator.lineage.client.properties

Description: For advanced use only, a string to be inserted into the client configuration for navigator.lineage.client.properties.
Related Name
Default Value
API Name: navigator_lineage_client_config_safety_valve
Required: false

Impala System Group (except Llama)

Description: The group that this Impala's processes should run as (except Llama, which has its own group).
Related Name
Default Value: impala
API Name: process_groupname
Required: true

Impala System User (except Llama)

Description: The user that this Impala's processes should run as (except Llama, which has its own user).
Related Name
Default Value: impala
API Name: process_username
Required: true

Impala Service Advanced Configuration Snippet (Safety Valve) for ranger-impala-audit.xml

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

Impala Service Advanced Configuration Snippet (Safety Valve) for ranger-impala-policymgr-ssl.xml

Description: For advanced use only, a string to be inserted into ranger-impala-policymgr-ssl.xml. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: ranger_policymgr_ssl_safety_valve
Required: false

Impala Service Advanced Configuration Snippet (Safety Valve) for ranger-impala-security.xml

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

Use Debug Build

Description: Use debug build of Impala binaries when starting roles. Useful when performing diagnostic activities to get more information in the stacktrace or core dump.
Related Name
Default Value: false
API Name: use_debug_build
Required: false

Cloudera Navigator

Enable Audit Collection

Description: Enable collection of audit events from the service's roles.
Related Name: navigator.audit.enabled
Default Value: true
API Name: navigator_audit_enabled
Required: false

Audit Event Filter

Description

Event filters are defined in a JSON object like the following:


{
  "defaultAction" : ("accept", "discard"),
  "rules" : [
    {
      "action" : ("accept", "discard"),
      "fields" : [
        {
          "name" : "fieldName",
          "match" : "regex"
        }
      ]
    }
  ]
}

A filter has a default action and a list of rules, in order of precedence. Each rule defines an action, and a list of fields to match against the audit event. A rule is "accepted" if all the listed field entries match the audit event. At that point, the action declared by the rule is taken. If no rules match the event, the default action is taken. Actions default to "accept" if not defined in the JSON object. The following is the list of fields that can be filtered for Impala events:

userName: the user performing the action.
ipAddress: the IP from where the request originated.
operation: the Impala operation being performed.
databaseName: the databaseName for the operation.
tableName: the tableName for the operation.

Related Name

navigator.event.filter

Default Value

API Name

navigator_audit_event_filter

Required

false

Audit Queue Policy

Description: Action to take when the audit event queue is full. Drop the event or shutdown the affected process.
Related Name: navigator.batch.queue_policy
Default Value: DROP
API Name: navigator_audit_queue_policy
Required: false

Audit Event Tracker

Description

Configures the rules for event tracking and coalescing. This feature is used to define equivalency between different audit events. When events match, according to a set of configurable parameters, only one entry in the audit list is generated for all the matching events. Tracking works by keeping a reference to events when they first appear, and comparing other incoming events against the "tracked" events according to the rules defined here. Event trackers are defined in a JSON object like the following:


{
  "timeToLive" : [integer],
  "fields" : [
    {
      "type" : [string],
      "name" : [string]
    }
  ]
}

Where:

timeToLive: maximum amount of time an event will be tracked, in milliseconds. Must be provided. This defines how long, since it's first seen, an event will be tracked. A value of 0 disables tracking.
fields: list of fields to compare when matching events against tracked events.

Each field has an evaluator type associated with it. The evaluator defines how the field data is to be compared. The following evaluators are available:

value: uses the field value for comparison.
userName: treats the field value as a userName, and ignores any host-specific data. This is useful for environment using Kerberos, so that only the principal name and realm are compared.

The following is the list of fields that can be used to compare Impala events:

operation: the Impala operation being performed.
username: the user performing the action.
ipAddress: the IP from where the request originated.
allowed: whether the operation was allowed or denied.
databaseName: the database affected by the operation.
tableName: the table affected by the operation.
objectType: the type of object affected by the operation.
privilege: the privilege associated with the operation.

Related Name

navigator_event_tracker

Default Value

API Name

navigator_event_tracker

Required

false

Enable Lineage Collection

Description: Enable collection of lineage from the service's roles.
Related Name
Default Value: true
API Name: navigator_lineage_enabled
Required: false

Monitoring

Admin Users Query List Visibility Settings

Description: Controls which queries admin users can see in the queries list view
Related Name
Default Value: ALL
API Name: admin_query_list_settings
Required: true

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 Impala Catalog Server Monitoring Thresholds

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

Healthy Impala Daemon Monitoring Thresholds

Description: The health test thresholds of the overall Impala Daemon health. The check returns "Concerning" health if the percentage of "Healthy" Impala Daemons falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Impala Daemons falls below the critical threshold.
Related Name
Default Value: Warning: 95.0 %, Critical: 90.0 %
API Name: impala_impalads_healthy_thresholds
Required: false

Healthy Impala Llama ApplicationMaster Monitoring Thresholds

Description: The health test thresholds of the overall Impala Llama ApplicationMaster health. The check returns "Concerning" health if the percentage of "Healthy" Impala Llama ApplicationMasters falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Impala Llama ApplicationMasters falls below the critical threshold.
Related Name
Default Value: Warning: 99.0 %, Critical: 51.0 %
API Name: impala_llamas_healthy_thresholds
Required: false

Impala Query Aggregates

Description: Controls the aggregate metrics generated for Impala queries. The structure is a JSON list of the attributes to aggregate and the entities to aggregate to. For example, if the attributeName is 'hdfs_bytes_read' and the aggregationTargets is ['USER'] then the Service Monitor will create the metric 'impala_query_hdfs_bytes_read_rate' and, every ten minutes, will record the total hdfs bytes read for each user across all their Impala queries. By default it will also record the number of queries issues ('num_impala_queries_rate') for both users and pool. For a full list of the supported attributes see the Impala search page. Note that the valid aggregation targets are USER, YARN_POOL, and IMPALA (the service), and that these aggregate metrics can be viewed on both the reports and charts search pages.
Related Name
Default Value: [ attributeName: hdfs_bytes_read, aggregationTargets: [USER, IMPALA_POOL_USER, IMPALA_POOL, IMPALA, CLUSTER] , attributeName: hdfs_bytes_written, aggregationTargets: [USER, IMPALA_POOL_USER, IMPALA_POOL, IMPALA, CLUSTER] , attributeName: thread_cpu_time, aggregationTargets: [USER, IMPALA_POOL_USER, IMPALA_POOL, IMPALA, CLUSTER] , attributeName: bytes_streamed, aggregationTargets: [USER, IMPALA_POOL_USER, IMPALA_POOL, IMPALA, CLUSTER] , attributeName: cm_cpu_milliseconds, aggregationTargets: [USER, IMPALA_POOL_USER, IMPALA_POOL, IMPALA, CLUSTER] , attributeName: query_duration, aggregationTargets: [USER, IMPALA_POOL_USER, IMPALA_POOL, IMPALA, CLUSTER] , attributeName: admission_wait, aggregationTargets: [USER, IMPALA_POOL_USER, IMPALA_POOL, IMPALA, CLUSTER] , attributeName: memory_accrual, aggregationTargets: [USER, IMPALA_POOL_USER, IMPALA_POOL, IMPALA, CLUSTER] , attributeName: thread_cpu_time, aggregationTargets: [USER, IMPALA_POOL_USER, IMPALA_POOL, IMPALA, CLUSTER] , attributeName: memory_spilled, aggregationTargets: [USER, IMPALA_POOL_USER, IMPALA_POOL, IMPALA, CLUSTER] ]
API Name: impala_query_aggregates
Required: false

Healthy Impala StateStore Monitoring Thresholds

Description: The health test thresholds of the overall Impala StateStore health. The check returns "Concerning" health if the percentage of "Healthy" Impala StateStores falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Impala StateStores falls below the critical threshold.
Related Name
Default Value: Warning: 99.0 %, Critical: 1.0 %
API Name: impala_statestore_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

Non-Admin Users Query List Visibility Settings

Description: Controls which queries a non-admin user can see in the queries list view
Related Name
Default Value: ALL
API Name: user_query_list_settings
Required: true

Other

Atlas Service

Description: Name of the Atlas service that this Impala service instance depends on
Related Name
Default Value
API Name: atlas_service
Required: false

Enable Profile Collection

Description: Enable collection of profile from the service's roles.
Related Name
Default Value: true
API Name: enable_telepub_profile_collection
Required: false

HBase Service

Description: Name of the HBase service that this Impala service instance depends on
Related Name
Default Value
API Name: hbase_service
Required: false

HDFS Service

Description: Name of the HDFS service that this Impala service instance depends on
Related Name
Default Value
API Name: hdfs_service
Required: true

Hive Service

Description: Name of the Hive service that this Impala service instance depends on
Related Name
Default Value
API Name: hive_service
Required: true

Kudu Service

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

Enable Local Catalog

Description: With local catalog enabled, the coordinators pull metadata as needed from catalog and cache it locally.
Related Name
Default Value: true
API Name: local_catalog_enabled
Required: false

Ranger Plugin Trusted Proxy IP Address

Description: Accepts a list of IP addresses of proxy servers for trusting.
Related Name: ranger.plugin.hive.trusted.proxy.ipaddress
Default Value
API Name: ranger_plugin_trusted_proxy_ipaddress
Required: false

Ranger Plugin URL Auth Filesystem Schemes

Description: Set Ranger URL Auth Filesystem Schemes.
Related Name: ranger.plugin.hive.urlauth.filesystem.schemes
Default Value: hdfs:, file:, wasb:, adl:
API Name: ranger_plugin_urlauth_filesystem_schemes
Required: false

Ranger Plugin Use X-Forwarded for IP Address

Description: The parameter is used for identifying the originating IP address of a user connecting to a component through proxy for audit logs.
Related Name: ranger.plugin.hive.use.x-forwarded-for.ipaddress
Default Value: false
API Name: ranger_plugin_use_x_forwarded_for_ipaddress
Required: false

Ranger Service

Description: Name of the Ranger service that this Impala service instance depends on
Related Name
Default Value
API Name: ranger_service
Required: false

YARN Service for Resource Management

Description: Name of YARN service to use for resource management integration between Impala and YARN. This service dependency and the existence of a Llama role is required for using said integration.
Related Name
Default Value
API Name: yarn_service
Required: false

ZooKeeper Service for Llama HA

Description: Name of the ZooKeeper service to use for leader election and fencing when Llama is configured for high availability. This service dependency is required when more than one Llama role is present.
Related Name
Default Value
API Name: zookeeper_service
Required: false

Performance

Enable HDFS Short-Circuit Read

Description: Enable HDFS short-circuit read. This allows a client colocated with the DataNode to read HDFS file blocks directly. This gives a performance boost to distributed clients that are aware of locality.
Related Name: dfs.client.read.shortcircuit
Default Value: true
API Name: dfs_client_read_shortcircuit
Required: false

Enable Iceberg manifest caching

Description: This option enables Iceberg manifest caching for Impala Coordinator and Catalog Server.
Related Name: iceberg_manifest_cache_enabled
Default Value: true
API Name: iceberg_manifest_cache_enabled
Required: false

StateStoreSubscriber Timeout

Description: Time in seconds before Impala Daemon or Catalog Server times out with the StateStore.
Related Name: statestore_subscriber_timeout_seconds
Default Value: 30 second(s)
API Name: statestore_subscriber_timeout
Required: false

Security

Atlas Kafka Messages Spool Directory

Description: Spool directory for Atlas Kafka Messages.
Related Name: atlas.hook.spool.dir
Default Value: /var/log/impala/atlas-spool
API Name: atlas_message_spool_path
Required: false

Enable TLS/SSL for Impala

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

Enable LDAP Authentication

Description: When checked, LDAP-based authentication for users is enabled.
Related Name: enable_ldap_auth
Default Value: false
API Name: enable_ldap_auth
Required: false

Enable LDAP TLS

Description: If true, attempts to establish a TLS (Transport Layer Security) connection with an LDAP server that was specified with ldap://. Not required when using an LDAP URL with prefix ldaps://, because that already specifies TLS. This option is also known as "Use StartTLS".
Related Name: ldap_tls
Default Value: false
API Name: enable_ldap_tls
Required: false

Enable Kerberos Authentication for HTTP Web-Consoles

Description: Enables Kerberos authentication for Hadoop HTTP web consoles for all roles of this service using the SPNEGO protocol. Note: This is effective only if Kerberos is enabled.
Related Name
Default Value: false
API Name: hadoop_secure_web_ui
Required: false

Proxy Group Configuration

Description: Specifies the set of authorized proxy groups (users who can impersonate other users belonging to the specified groups during authorization) and whom they are allowed to impersonate. Input is a semicolon-separated list of key=value pairs of authorized proxy users to the group(s) they can impersonate. These groups are specified as a comma separated list of groups, or '*' to indicate all groups. For example: joe=group1,group2;hue=*;admin=*. Only valid when Sentry is enabled.
Related Name: authorized_proxy_group_config
Default Value
API Name: impala_authorized_proxy_group_config
Required: false

Proxy User Configuration

Description: Specifies the set of authorized proxy users (users who can impersonate other users during authorization) and whom they are allowed to impersonate. Input is a semicolon-separated list of key=value pairs of authorized proxy users to the user(s) they can impersonate. These users are specified as a comma separated list of short usernames, or '*' to indicate all users. For example: joe=alice,bob;hue=*;admin=*. Only valid when Sentry is enabled.
Related Name: authorized_proxy_user_config
Default Value: hue=*;knox=*
API Name: impala_authorized_proxy_user_config
Required: false

LDAP URL

Description: The URL of the LDAP Server. The URL must be prefixed with ldap:// or ldaps:// . The URL can optionally specify a custom port if necessary, but by default the ldap:// will connect to port 389, and the ldaps:// will connect to port 636. Note that passwords will be in the clear if ldap:// is used, and by fall 2020 Active directory servers will no longer allow non LDAPS connections to bind to AD hosts with LDAP signing enabled. See microsoft knowledge document 935834 for more information.
Related Name: ldap_uri
Default Value
API Name: impala_ldap_uri
Required: false

impala TLS/SSL Trust Store File

Description: The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that impala might connect to. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead.
Related Name
Default Value
API Name: impala_truststore_file
Required: false

impala TLS/SSL Trust Store Password

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

Kerberos Principal

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

Kerberos Re-init Interval

Description: Number of minutes between reestablishing our ticket with the Kerberos server.
Related Name: kerberos_reinit_interval
Default Value: 1 hour(s)
API Name: kerberos_reinit_interval
Required: false

LDAP BaseDN

Description: This parameter is useful when authenticating against a non-Active Directory server, such as OpenLDAP. When set, this parameter is used to convert the username into the LDAP Distinguished Name (DN), so that the resulting DN looks like uid=username,*this parameter*. For example, if this parameter is set to "ou=People,dc=cloudera,dc=com", and the username passed in is "mike", the resulting authentication passed to the LDAP server look like "uid=mike,ou=People,dc=cloudera,dc=com". This parameter is mutually exclusive with Active Directory Domain.
Related Name: ldap_baseDN
Default Value
API Name: ldap_baseDN
Required: false

LDAP Pattern

Description: When set, this parameter allows arbitrary mapping from usernames into a Distinguished Name (DN). The string specified must have a placeholder named "#UID" inside it, and that #UID is replaced with the username. For example, you could mimic the behavior of LDAP BaseDN by specifying "uid=#UID,ou=People,dc=cloudera,dc=com". When the username of "mike" comes in, it replaces the #UID and the result is "uid=mike,ou=People,dc=cloudera,dc=com". This option should be used when more control over the DN is needed. This parameter is mutually exclusive with LDAP Domain and LDAP BaseDN.
Related Name: ldap_bind_pattern
Default Value
API Name: ldap_bind_pattern
Required: false

Impala Client LDAP Password

Description: The password for connecting to Impala when using LDAP authentication. This is used by Cloudera Manager to execute Impala APIs like cancelling a query.
Related Name: ldap_cm_password
Default Value
API Name: ldap_cm_password
Required: false

Impala Client LDAP Username

Description: The username for connecting to Impala when using LDAP authentication. This is used by Cloudera Manager to execute Impala APIs like cancelling a query.
Related Name: ldap_cm_user
Default Value
API Name: ldap_cm_user
Required: false

Active Directory Domain

Description: Use this field for Active Directory configurations only, when combined with a simple username value in the "LDAP Bind User Distinguished Name" field, it will result in a UPM of user@example.com used for search/bind operations for authenticated user lookups.
Related Name: ldap_domain
Default Value
API Name: ldap_domain
Required: false

Ranger DFS Audit Path

Description: The DFS path on which Ranger audits are written. The special placeholder '${ranger_base_audit_url}' should be used as the prefix, in order to use the centralized location defined in the Ranger service.
Related Name: xasecure.audit.destination.hdfs.dir
Default Value: $ranger_base_audit_url/impala
API Name: ranger_audit_hdfs_dir
Required: false

Ranger Audit DFS Spool Dir

Description: Spool directory for Ranger audits being written to DFS.
Related Name: xasecure.audit.destination.hdfs.batch.filespool.dir
Default Value: /var/log/impala/audit/hdfs/spool
API Name: ranger_audit_hdfs_spool_dir
Required: false

Ranger Audit Solr Spool Dir

Description: Spool directory for Ranger audits being written to Solr.
Related Name: xasecure.audit.destination.solr.batch.filespool.dir
Default Value: /var/log/impala/audit/solr/spool
API Name: ranger_audit_solr_spool_dir
Required: false

Ranger Policy Cache Directory

Description: The directory where Ranger security policies are cached locally.
Related Name: ranger.plugin.hive.policy.cache.dir
Default Value: /var/lib/ranger/impala/policy-cache
API Name: ranger_policy_cache_dir
Required: false

The allowed set of OpenSSL ciphers

Description: A list of OpenSSL ciphers, optionally including other notation. See the output of 'man ciphers' for the full set of keywords and notation allowed in the arguments.
Related Name: ssl_cipher_list
Default Value
API Name: ssl_cipher_list
Required: false

Impala TLS/SSL CA Certificate

Description: The location on disk of the certificate, in PEM format, used to confirm the authenticity of SSL/TLS servers that the Impala daemons might connect to. Because the Impala daemons connect to each other, this should also include the CA certificate used to sign all the SSL/TLS Certificates. Without this parameter, SSL/TLS between Impala daemons will not be enabled.
Related Name: ssl_client_ca_certificate
Default Value
API Name: ssl_client_ca_certificate
Required: false

Impala 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 Impala is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name: ssl_private_key
Default Value
API Name: ssl_private_key
Required: false

Impala TLS/SSL Private Key Password

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

Impala 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 Impala is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name: ssl_server_certificate
Default Value
API Name: ssl_server_certificate
Required: false

Suppressions

Suppress Configuration Validator: Impala Daemon Audit Log Directory

Description: Whether to suppress configuration warnings produced by the Impala Daemon Audit Log Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_audit_event_log_dir
Required: true

Suppress Configuration Validator: Impala Daemon Backend Port

Description: Whether to suppress configuration warnings produced by the Impala Daemon Backend Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_be_port
Required: true

Suppress Configuration Validator: Impala Daemon Beeswax Port

Description: Whether to suppress configuration warnings produced by the Impala Daemon Beeswax Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_beeswax_port
Required: true

Suppress Configuration Validator: Catalog Server Service Port

Description: Whether to suppress configuration warnings produced by the Catalog Server Service Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_catalog_service_port
Required: true

Suppress Configuration Validator: Catalog Server Command Line Argument Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Catalog Server Command Line Argument Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_catalogd_cmd_args_safety_valve
Required: true

Suppress Configuration Validator: Impala Catalog Server Advanced Configuration Snippet (Safety Valve) for core-site.xml

Description: Whether to suppress configuration warnings produced by the Impala Catalog Server Advanced Configuration Snippet (Safety Valve) for core-site.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_catalogd_core_site_safety_valve
Required: true

Suppress Configuration Validator: Catalog Server HBase Advanced Configuration Snippet (Safety Valve)

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

Suppress Configuration Validator: Catalog Server HDFS Advanced Configuration Snippet (Safety Valve)

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

Suppress Configuration Validator: Catalog Server Hive Advanced Configuration Snippet (Safety Valve)

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

Suppress Configuration Validator: Java Configuration Options for Catalog Server

Description: Whether to suppress configuration warnings produced by the Java Configuration Options for Catalog Server configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_catalogd_java_opts
Required: true

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

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

Suppress Configuration Validator: Catalog Server HTTP Server Port

Description: Whether to suppress configuration warnings produced by the Catalog Server HTTP Server Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_catalogserver_webserver_port
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: Impala Daemon Core Dump Directory

Description: Whether to suppress configuration warnings produced by the Impala Daemon Core Dump Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_core_dump_dir
Required: true

Suppress Configuration Validator: Impala Daemon Data Cache Directories

Description: Whether to suppress configuration warnings produced by the Impala Daemon Data Cache Directories configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_datacache_dirs
Required: true

Suppress Configuration Validator: Impala Daemon Default Memory Limit Validator

Description: Whether to suppress configuration warnings produced by the Impala Daemon Default Memory Limit Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_default_impalad_memory_limit_validator
Required: true

Suppress Configuration Validator: Impala Daemon Default Query Options

Description: Whether to suppress configuration warnings produced by the Impala Daemon Default Query Options configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_default_query_options
Required: true

Suppress Configuration Validator: Impala Daemon HiveServer2 HTTP Port

Description: Whether to suppress configuration warnings produced by the Impala Daemon HiveServer2 HTTP Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hs2_http_port
Required: true

Suppress Configuration Validator: Impala Daemon HiveServer2 Port

Description: Whether to suppress configuration warnings produced by the Impala Daemon HiveServer2 Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hs2_port
Required: true

Suppress Configuration Validator: Impala Audit Enabled Validator

Description: Whether to suppress configuration warnings produced by the Impala Audit Enabled Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impala_audit_enabled_validator
Required: true

Suppress Configuration Validator: Impala Daemon HDFS Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Impala Daemon HDFS Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impala_hdfs_site_conf_safety_valve
Required: true

Suppress Configuration Validator: Impala Daemon Hive Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Impala Daemon Hive Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impala_hive_conf_safety_valve
Required: true

Suppress Configuration Validator: Impala Lineage Enabled Validator

Description: Whether to suppress configuration warnings produced by the Impala Lineage Enabled Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impala_lineage_enabled_validator
Required: true

Suppress Configuration Validator: Impala Daemon Llama Site Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Impala Daemon Llama Site Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impala_llama_site_conf_safety_valve
Required: true

Suppress Configuration Validator: Impala Daemons Load Balancer Hiveserver2 Port

Description: Whether to suppress configuration warnings produced by the Impala Daemons Load Balancer Hiveserver2 Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impala_load_balancer_hs2_port
Required: true

Suppress Configuration Validator: Impala Daemon Command Line Argument Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Impala Daemon Command Line Argument Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_cmd_args_safety_valve
Required: true

Suppress Configuration Validator: Impala Daemon Command Line Arguments Safety Valve Validator

Description: Whether to suppress configuration warnings produced by the Impala Daemon Command Line Arguments Safety Valve Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_cmd_args_safety_valve_validator
Required: true

Suppress Configuration Validator: Impala Daemon Advanced Configuration Snippet (Safety Valve) for core-site.xml

Description: Whether to suppress configuration warnings produced by the Impala Daemon Advanced Configuration Snippet (Safety Valve) for core-site.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_core_site_safety_valve
Required: true

Suppress Configuration Validator: Java Configuration Options for Impala Daemon

Description: Whether to suppress configuration warnings produced by the Java Configuration Options for Impala Daemon configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_embedded_java_opts
Required: true

Suppress Configuration Validator: Impala Daemon Fair Scheduler Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Impala Daemon Fair Scheduler Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_fair_scheduler_safety_valve
Required: true

Suppress Configuration Validator: Impala Daemon HBase Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Impala Daemon HBase Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_hbase_conf_safety_valve
Required: true

Suppress Configuration Validator: LDAP Server CA Certificate

Description: Whether to suppress configuration warnings produced by the LDAP Server CA Certificate configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_ldap_ca_certificate
Required: true

Suppress Configuration Validator: Impala Daemons Load Balancer

Description: Whether to suppress configuration warnings produced by the Impala Daemons Load Balancer configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_load_balancer
Required: true

Suppress Configuration Validator: Impala Daemon Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Configuration Validator: Impala Daemon HTTP Server Port

Description: Whether to suppress configuration warnings produced by the Impala Daemon HTTP Server Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_impalad_webserver_port
Required: true

Suppress Configuration Validator: JMX Exporter configuration YAML

Description: Whether to suppress configuration warnings produced by the JMX Exporter configuration YAML configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_yaml
Required: true

Suppress Configuration Validator: JWKS URL

Description: Whether to suppress configuration warnings produced by the JWKS URL configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_jwks_url
Required: true

Suppress Configuration Validator: Username JWT Custom Claim

Description: Whether to suppress configuration warnings produced by the Username JWT Custom Claim configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_jwt_custom_claim_username
Required: true

Suppress Configuration Validator: Impala Daemon KRPC Port

Description: Whether to suppress configuration warnings produced by the Impala Daemon KRPC Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_krpc_port
Required: true

Suppress Configuration Validator: Impala Daemon Lineage Log Directory

Description: Whether to suppress configuration warnings produced by the Impala Daemon Lineage Log Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_lineage_event_log_dir
Required: true

Suppress Configuration Validator: Llama Callback Port

Description: Whether to suppress configuration warnings produced by the Llama Callback Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_llama_callback_port
Required: true

Suppress Configuration Validator: Local UDF Library Dir

Description: Whether to suppress configuration warnings produced by the Local UDF Library Dir configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_local_library_dir
Required: true

Suppress Configuration Validator: Impala Daemon Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Impala Daemon Logging Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Suppress Configuration Validator: Impala Daemon Log Directory

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

Suppress Configuration Validator: Impala Daemon Breakpad Dump Directory

Description: Whether to suppress configuration warnings produced by the Impala Daemon Breakpad Dump Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_minidump_path
Required: true

Suppress Configuration Validator: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Exporters Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Extensions Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Helper Port

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Helper Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_helper_port
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Processors Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Receivers Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write URL configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write Username configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Configuration Validator: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section

Description: Whether to suppress configuration warnings produced by the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_exporters
Required: true

Suppress Configuration Validator: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section

Description: Whether to suppress configuration warnings produced by the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_extensions
Required: true

Suppress Configuration Validator: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section

Description: Whether to suppress configuration warnings produced by the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_processors
Required: true

Suppress Configuration Validator: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section

Description: Whether to suppress configuration warnings produced by the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_receivers
Required: true

Suppress Configuration Validator: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section

Description: Whether to suppress configuration warnings produced by the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_service
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Service Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
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: Impala Daemon Scratch Directories

Description: Whether to suppress configuration warnings produced by the Impala Daemon Scratch Directories configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_scratch_dirs
Required: true

Suppress Configuration Validator: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Configuration Validator: Second Statestore Host Name

Description: Whether to suppress configuration warnings produced by the Second Statestore Host Name configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_state_store_2_host
Required: true

Suppress Configuration Validator: Statestore HA Port

Description: Whether to suppress configuration warnings produced by the Statestore HA Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_state_store_ha_port
Required: true

Suppress Configuration Validator: Statestore Host Name

Description: Whether to suppress configuration warnings produced by the Statestore Host Name configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_state_store_host
Required: true

Suppress Configuration Validator: Peer Statestore Host Name

Description: Whether to suppress configuration warnings produced by the Peer Statestore Host Name configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_state_store_peer_host
Required: true

Suppress Configuration Validator: StateStoreSubscriber Service Port

Description: Whether to suppress configuration warnings produced by the StateStoreSubscriber Service Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_state_store_subscriber_port
Required: true

Suppress Configuration Validator: Statestore Command Line Argument Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Statestore Command Line Argument Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_statestore_cmd_args_safety_valve
Required: true

Suppress Configuration Validator: Impala StateStore Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Configuration Validator: StateStore HTTP Server Port

Description: Whether to suppress configuration warnings produced by the StateStore HTTP Server Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_statestore_webserver_port
Required: true

Suppress Configuration Validator: Impala Daemon Unlimited Memory Limit Validator

Description: Whether to suppress configuration warnings produced by the Impala Daemon Unlimited Memory Limit Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_unlimited_impalad_memory_limit_validator
Required: true

Suppress Configuration Validator: Impala Daemon Webserver TLS/SSL Server Certificate File (PEM Format)

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

Suppress Configuration Validator: Impala Daemon Web Server User Password

Description: Whether to suppress configuration warnings produced by the Impala Daemon Web Server User Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_htpassword_password
Required: true

Suppress Configuration Validator: Impala Daemon Web Server Username

Description: Whether to suppress configuration warnings produced by the Impala Daemon Web Server Username configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_webserver_htpassword_user
Required: true

Suppress Configuration Validator: Impala Daemon Webserver TLS/SSL Server Private Key File (PEM Format)

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

Suppress Configuration Validator: Impala Daemon Webserver TLS/SSL Private Key Password

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

Suppress Parameter Validation: Impala Service Advanced Configuration Snippet (Safety Valve) for atlas-application.properties

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

Suppress Parameter Validation: Atlas Kafka Messages Spool Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Atlas Kafka Messages Spool Directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_atlas_message_spool_path
Required: true

Suppress Configuration Validator: Impala Catalog Server Count Validator

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

Suppress Configuration Validator: Secure Web UI Validator

Description: Whether to suppress configuration warnings produced by the Secure Web UI Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_hadoop_secure_web_ui
Required: true

Suppress Configuration Validator: Ranger Plugin Url Auth Validator for filesystem schemes

Description: Whether to suppress configuration warnings produced by the Ranger Plugin Url Auth Validator for filesystem schemes configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_hive_ranger_url_auth_validator
Required: true

Suppress Parameter Validation: Proxy Group Configuration

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

Suppress Parameter Validation: Proxy User Configuration

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

Suppress Configuration Validator: Bypass Hive Metastore Validator

Description: Whether to suppress configuration warnings produced by the Bypass Hive Metastore Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_impala_bypass_hms_validator
Required: true

Suppress Parameter Validation: Impala Command Line Argument Advanced Configuration Snippet (Safety Valve)

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

Suppress Configuration Validator: Impala Command Line Arguments Safety Valve Validator

Description: Whether to suppress configuration warnings produced by the Impala Command Line Arguments Safety Valve Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_impala_cmd_args_safety_valve_validator
Required: true

Suppress Configuration Validator: Impala Short-Circuit Read Validator

Description: Whether to suppress configuration warnings produced by the Impala Short-Circuit Read Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_impala_dfs_client_read_shortcircuit_validator
Required: true

Suppress Configuration Validator: Enable HDFS Block Metadata API Configuration Validator

Description: Whether to suppress configuration warnings produced by the Enable HDFS Block Metadata API Configuration Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_impala_hdfs_dfs_datanode_hdfs_blocks_metadata_enabled_set_validator
Required: true

Suppress Parameter Validation: LDAP URL

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

Suppress Configuration Validator: LDAP Configuration Validator

Description: Whether to suppress configuration warnings produced by the LDAP Configuration Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_impala_ldap_validator
Required: true

Suppress Configuration Validator: Impala Llama Supported Validator

Description: Whether to suppress configuration warnings produced by the Impala Llama Supported Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_impala_llama_supported_validator
Required: true

Suppress Parameter Validation: Impala Query Aggregates

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Query Aggregates parameter.
Related Name
Default Value: false
API Name: service_config_suppression_impala_query_aggregates
Required: true

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

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

Suppress Configuration Validator: Impala Specialization Validator

Description: Whether to suppress configuration warnings produced by the Impala Specialization Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_impala_specialization_validator
Required: true

Suppress Parameter Validation: impala TLS/SSL Trust Store File

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the impala TLS/SSL Trust Store File parameter.
Related Name
Default Value: false
API Name: service_config_suppression_impala_truststore_file
Required: true

Suppress Parameter Validation: impala TLS/SSL Trust Store Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the impala TLS/SSL Trust Store Password parameter.
Related Name
Default Value: false
API Name: service_config_suppression_impala_truststore_password
Required: true

Suppress Configuration Validator: Impala Daemon Count Validator

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

Suppress Parameter Validation: Impala Service Advanced Configuration Snippet (Safety Valve) for sentry-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Service Advanced Configuration Snippet (Safety Valve) for sentry-site.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_impalad_sentry_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: LDAP BaseDN

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

Suppress Parameter Validation: LDAP Pattern

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

Suppress Parameter Validation: Impala Client LDAP Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Client LDAP Password parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ldap_cm_password
Required: true

Suppress Parameter Validation: Impala Client LDAP Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Client LDAP Username parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ldap_cm_user
Required: true

Suppress Parameter Validation: Active Directory Domain

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

Suppress Parameter Validation: Audit Event Filter

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Audit Event Filter parameter.
Related Name
Default Value: false
API Name: service_config_suppression_navigator_audit_event_filter
Required: true

Suppress Parameter Validation: Impala Client Advanced Configuration Snippet (Safety Valve) for navigator.client.properties

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Client Advanced Configuration Snippet (Safety Valve) for navigator.client.properties parameter.
Related Name
Default Value: false
API Name: service_config_suppression_navigator_client_config_safety_valve
Required: true

Suppress Parameter Validation: Audit Event Tracker

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Audit Event Tracker parameter.
Related Name
Default Value: false
API Name: service_config_suppression_navigator_event_tracker
Required: true

Suppress Parameter Validation: Impala Client Advanced Configuration Snippet (Safety Valve) for navigator.lineage.client.properties

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Client Advanced Configuration Snippet (Safety Valve) for navigator.lineage.client.properties parameter.
Related Name
Default Value: false
API Name: service_config_suppression_navigator_lineage_client_config_safety_valve
Required: true

Suppress Configuration Validator: CA Certificate File Validator

Description: Whether to suppress configuration warnings produced by the CA Certificate File Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_pem_ca_cert_recommended_for_ssl
Required: true

Suppress Parameter Validation: Impala System Group (except Llama)

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

Suppress Parameter Validation: Impala System User (except Llama)

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

Suppress Parameter Validation: Ranger DFS Audit Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger DFS Audit Path parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_audit_hdfs_dir
Required: true

Suppress Parameter Validation: Ranger Audit DFS Spool Dir

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Audit DFS Spool Dir parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_audit_hdfs_spool_dir
Required: true

Suppress Parameter Validation: Impala Service Advanced Configuration Snippet (Safety Valve) for ranger-impala-audit.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Service Advanced Configuration Snippet (Safety Valve) for ranger-impala-audit.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_audit_safety_valve
Required: true

Suppress Parameter Validation: Ranger Audit Solr Spool Dir

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Audit Solr Spool Dir parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_audit_solr_spool_dir
Required: true

Suppress Parameter Validation: Ranger Plugin Trusted Proxy IP Address

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Plugin Trusted Proxy IP Address parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_plugin_trusted_proxy_ipaddress
Required: true

Suppress Parameter Validation: Ranger Plugin URL Auth Filesystem Schemes

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Plugin URL Auth Filesystem Schemes parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_plugin_urlauth_filesystem_schemes
Required: true

Suppress Parameter Validation: Ranger Policy Cache Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Policy Cache Directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_policy_cache_dir
Required: true

Suppress Parameter Validation: Impala Service Advanced Configuration Snippet (Safety Valve) for ranger-impala-policymgr-ssl.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Service Advanced Configuration Snippet (Safety Valve) for ranger-impala-policymgr-ssl.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_policymgr_ssl_safety_valve
Required: true

Suppress Parameter Validation: Impala Service Advanced Configuration Snippet (Safety Valve) for ranger-impala-security.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala Service Advanced Configuration Snippet (Safety Valve) for ranger-impala-security.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_security_safety_valve
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 Configuration Validator: Short-Circuit Read Enabled Validator

Description: Whether to suppress configuration warnings produced by the Short-Circuit Read Enabled Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_short_circuit_read_validator
Required: true

Suppress Configuration Validator: Short-Circuit Read Permissions Validator

Description: Whether to suppress configuration warnings produced by the Short-Circuit Read Permissions Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_short_circuit_reads_data_directory_permissions_validator
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: The allowed set of OpenSSL ciphers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the The allowed set of OpenSSL ciphers parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ssl_cipher_list
Required: true

Suppress Parameter Validation: Impala TLS/SSL CA Certificate

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Impala TLS/SSL CA Certificate parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ssl_client_ca_certificate
Required: true

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

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

Suppress Parameter Validation: Impala TLS/SSL Private Key Password

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

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

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

Suppress Configuration Validator: Impala StateStore Count Validator

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

Suppress Health Test: Impala Catalog Server Health

Description: Whether to suppress the results of the Impala Catalog 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_impala_catalogserver_healthy
Required: true

Suppress Health Test: Impala Daemon Health

Description: Whether to suppress the results of the Impala Daemon 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_impala_impalads_healthy
Required: true

Suppress Health Test: Impala Llama ApplicationMaster Health

Description: Whether to suppress the results of the Impala Llama ApplicationMaster 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_impala_llamas_healthy
Required: true

Suppress Health Test: Impala StateStore Health

Description: Whether to suppress the results of the Impala StateStore 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_impala_statestore_healthy
Required: true