Hive Properties in Cloudera Runtime 7.3.1

Role groups:

Gateway

Advanced

Deploy Directory

Description: The directory where the client configs will be deployed
Related Name
Default Value: /etc/hive
API Name: client_config_root_dir
Required: true

Hive Client Advanced Configuration Snippet (Safety Valve) for hive-site.xml

Description: For advanced use only, a string to be inserted into the client configuration for hive-site.xml.
Related Name
Default Value
API Name: hive_client_config_safety_valve
Required: false

Gateway Client Environment Advanced Configuration Snippet (Safety Valve) for hive-env.sh

Description: For advanced use only, key-value pairs (one on each line) to be inserted into the client configuration for hive-env.sh
Related Name
Default Value
API Name: hive_client_env_safety_valve
Required: false

Client Java Configuration Options

Description: These are Java command-line arguments. Commonly, garbage collection flags, PermGen, or extra debugging flags would be passed here.
Related Name
Default Value: -Djava.net.preferIPv4Stack=true
API Name: hive_client_java_opts
Required: false

Hive Metastore Connection Timeout

Description: Timeout for requests to the Hive Metastore Server. Consider increasing this if you have tables with a lot of metadata and see timeout errors. Used by most Hive Metastore clients such as Hive CLI and HiveServer2, but not by Impala. Impala has a separately configured timeout.
Related Name: hive.metastore.client.socket.timeout
Default Value: 5 minute(s)
API Name: hive_metastore_timeout
Required: false

Gateway 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

Logs

Gateway Logging Threshold

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

Monitoring

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

Other

Alternatives Priority

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

Resource Management

Client Java Heap Size in Bytes

Description: Maximum size in bytes for the Java process heap memory. Passed to Java -Xmx.
Related Name
Default Value: 2 GiB
API Name: hive_client_java_heapsize
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: Deploy Directory

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

Suppress Parameter Validation: Hive Client Advanced Configuration Snippet (Safety Valve) for hive-site.xml

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

Suppress Parameter Validation: Gateway Client Environment Advanced Configuration Snippet (Safety Valve) for hive-env.sh

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

Suppress Parameter Validation: Client Java Configuration Options

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

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

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

Hive Metastore Server

Advanced

Turn on compactor initiator thread.

Description: When enabled, the initiator and cleaner threads will run on this Hive Metastore instance.
Related Name: hive.compactor.initiator.on
Default Value: true
API Name: hive_compactor_initiator_on
Required: true

Number of Threads Used by Compactor

Description: Number of compactor worker threads to run on this metastore instance. Can be different values on different Metastore instances.
Related Name: hive.compactor.worker.threads
Default Value: 5
API Name: hive_compactor_worker_threads
Required: true

Base Directory for Hive Proto Hook

Description: The directory where hive proto hooks should write the events, should generally be location of query_data table under sys.db database.
Related Name: hive.hook.proto.base-directory
Default Value: /warehouse/tablespace/managed/hive/sys.db/query_data/
API Name: hive_hook_proto_base_directory
Required: false

Enable additional acid related metrics

Description: Whether to collect additional acid related metrics outside of the acid metrics service. (metastore.metrics.enabled and/or hive.server2.metrics.enabled are also required to be set to true.)
Related Name: hive.metastore.acidmetrics.ext.on
Default Value: false
API Name: hive_metastore_acid_metrics_ext_on
Required: true

Hive Metastore Server Advanced Configuration Snippet (Safety Valve) for hive-site.xml

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

Hive Metastore Delegation Token Store

Description: The delegation token store implementation class. Use DBTokenStore for Highly Available Metastore Configuration.
Related Name: hive.cluster.delegation.token.store.class
Default Value: org.apache.hadoop.hive.thrift.DBTokenStore
API Name: hive_metastore_delegation_token_store
Required: false

Hive Metastore 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: hive_metastore_env_safety_valve
Required: false

Turn on Hive Metastore housekeeping threads.

Description: When enabled, the threads listed under metastore.task.threads.remote (defaults: AcidHouseKeeperService, AcidOpenTxnsCounterService, AcidCompactionHistoryService, AcidWriteSetService, MaterializationsRebuildLockCleanerTask, PartitionManagementTask) will be started when the Hive Metastore is started.
Related Name: hive.metastore.housekeeping.threads.on
Default Value: true
API Name: hive_metastore_housekeeping_threads_on
Required: true

Java Configuration Options for Hive Metastore 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: JAVA_GC_ARGS
API Name: hive_metastore_java_opts
Required: false

Max Hive Metastore Server Threads

Description: Maximum number of worker threads in the Hive Metastore Server's thread pool
Related Name: hive.metastore.server.max.threads
Default Value: 100000
API Name: hive_metastore_max_threads
Required: true

Min Hive Metastore Server Threads

Description: Minimum number of worker threads in the Hive Metastore Server's thread pool
Related Name: hive.metastore.server.min.threads
Default Value: 200
API Name: hive_metastore_min_threads
Required: true

Max Message Size for Hive MetaStore

Description: Maximum message size Hive MetaStore accepts.
Related Name: hive.metastore.server.max.message.size
Default Value: 100 MiB
API Name: hive_metastore_server_max_message_size
Required: false

Enable Metrics Subsystem

Description: Controls whether the Hive metrics subsystem is enabled for the role.
Related Name: hive.metastore.metrics.enabled
Default Value: true
API Name: hive_metrics_enabled
Required: false

Metrics Sample File Location

Description: The full path to a file with a sample of metrics exposed by the role. The sample is updated at the frequency configured by Metrics Sample File Logging Frequency. By default, the sample file is logged to a directory under the role log directory, e.g., /var/log/hive/metrics-hivemetastore/metrics.log. The setting only has an effect if "Enable Metrics Subsystem" is set to true.
Related Name: hive.service.metrics.file.location
Default Value
API Name: hive_metrics_sample_file_location
Required: false

Metrics Sample File Logging Frequency

Description: The frequency at which the metrics are logged to the sample file. The setting only has an effect if "Enable Metrics Subsystem" is set to true.
Related Name: hive.service.metrics.file.frequency
Default Value: 30 second(s)
API Name: hive_metrics_sample_logging_frequency
Required: false

Hive Metastore 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: hms_core_site_safety_valve
Required: false

Hive Metastore Server 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

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

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: false
API Name: process_auto_restart
Required: true

Enable Metric Collection

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

Process Start Retry Attempts

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

Process Start Wait Timeout

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

Logs

Hive Metastore Server Log Directory

Description: Directory where Hive Metastore Server will place its log files.
Related Name
Default Value: /var/log/hive
API Name: hive_log_dir
Required: false

Enable Performance Logging

Description: When enabled, it captures time spent during each part of the query execution for the role.
Related Name: hive.metastore.performance.logging.enabled
Default Value: true
API Name: hive_performance_logging_enabled
Required: false

Hive Metastore Server Logging Threshold

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

Hive Metastore Server Maximum Log File Backups

Description: The maximum number of rolled log files to keep for Hive Metastore Server logs. Typically used by log4j or logback.
Related Name
Default Value: 10
API Name: max_log_backup_index
Required: false

Hive Metastore Server Max Log Size

Description: The maximum size, in megabytes, per log file for Hive Metastore Server 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

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

Hive Metastore Server Host Health Test

Description: When computing the overall Hive Metastore Server health, consider the host's health.
Related Name
Default Value: true
API Name: hivemetastore_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: hivemetastore_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: hivemetastore_pause_duration_window
Required: false

Hive Metastore Server Process Health Test

Description: Enables the health test that the Hive Metastore Server's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: hivemetastore_scm_health_enabled
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: startDelaySeconds: 10 ssl: false lowercaseOutputName: true lowercaseOutputLabelNames: true rules: - pattern: 'metrics<name=(compaction_num_.*)><>(.*): (\d+)' name: hive_$1 value: $3 - pattern: 'metrics<name=(jvm\.pause.*)><>(.*): (\d+)' name: hive_$1_$2 value: $3 - pattern: 'metrics<name=((compaction_)?oldest.*age_in_sec)><>(.*): (\d+)' name: hive_$1 value: $4 - pattern: 'metrics<name=((total_)?num.*_transactions)><>(.*): (\d+)' name: hive_$1 value: $4 - pattern: 'metrics<name=(open_connections)><>(.*): (\d+)' name: hive_$1 value: $3 - pattern: 'metrics<name=(num_writes_to_disabled_compaction_table)><>(.*): (\d+)' name: hive_$1 value: $3
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

Hive Metastore Canary Health Test

Description: Enables the health test that checks that basic Hive Metastore operations succeed
Related Name
Default Value: true
API Name: metastore_canary_health_enabled
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)'
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: 11120
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: #memory - jvm_buffer_pool_used_bytes - jvm_buffer_pool_capacity_bytes - jvm_buffer_pool_used_buffers - jvm_memory_bytes_used - jvm_memory_bytes_committed - jvm_memory_bytes_max - jvm_memory_bytes_init #gc - jvm_gc_collection_seconds #threads - jvm_threads_current - jvm_threads_daemon - jvm_threads_peak - jvm_threads_started_total - jvm_threads_deadlocked - jvm_threads_deadlocked_monitor - jvm_threads_state #classes - jvm_classes_currently_loaded #process - process_cpu_seconds_total - process_start_time_seconds - process_open_fds - process_virtual_memory_bytes #jvm pause - hive_jvm_pause_extrasleeptime_count #compaction num - hive_compaction_num_completed_txn_components - hive_compaction_num_did_not_initiate - hive_compaction_num_failed - hive_compaction_num_initiated - hive_compaction_num_initiators - hive_compaction_num_ready_for_cleaning - hive_compaction_num_succeeded - hive_compaction_num_working #oldest age in sec - hive_oldest_open_non_repl_txn_age_in_sec - hive_oldest_open_repl_txn_age_in_sec - hive_oldest_ready_for_cleaning_age_in_sec - hive_compaction_oldest_enqueue_age_in_sec #num transactions - hive_num_open_transactions - hive_total_num_aborted_transactions - hive_total_num_committed_transactions - hive_total_num_timed_out_transactions #open connections - hive_open_connections #disabled compaction table - hive_num_writes_to_disabled_compaction_table
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 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

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 Hive Metastore 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 Hive Metastore 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 Stored Notifications in Database

Description: Enable stored notifications of metadata changes. When enabled, each metadata change will be stored in NOTIFICATION_LOG.
Related Name
Default Value: true
API Name: hive_enable_db_notification
Required: false

Enable Readonly mode for databases

Description: Registers Pre-execution hook which makes database readonly.
Related Name
Default Value: false
API Name: hive_enforce_read_only
Required: false

Time-to-live for Database Notifications

Description: Time-to-live in seconds for notifications present in NOTIFICATION_LOG. Only used when Enable Stored Notifications in Database is enabled.
Related Name: hive.metastore.event.db.listener.timetolive
Default Value: 2 day(s)
API Name: hive_metastore_event_db_listener_timetolive
Required: false

Hive Metastore Server Filter Hook

Description: Class name for the Hive Metastore Server Filter Hook. The class needs to implement the org.apache.hadoop.hive.metastore.MetastoreFilterHook interface.
Related Name: hive.metastore.filter.hook
Default Value: org.apache.hadoop.hive.ql.security.authorization.plugin.metastore.HiveMetaStoreAuthorizer
API Name: hive_metastore_filter_hook
Required: false

Enable Hive Metastore Server Filter

Description: When checked, the Hive Metastore Server will filter results based on the Filter Hook.
Related Name: hive.metastore.server.filter.enabled
Default Value: true
API Name: hive_metastore_server_filter_enabled
Required: false

ChangeManager root directory

Description: Root dir for ChangeManager, used for deleted files.
Related Name: hive.repl.cmrootdir
Default Value: /user/$user/cmroot
API Name: hive_repl_cm_rootdir
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

Hive Metastore Server Port

Description: Port on which Hive Metastore Server will listen for connections.
Related Name: hive.metastore.port
Default Value: 9083
API Name: hive_metastore_port
Required: false

Resource Management

Java Heap Size of Hive Metastore Server in Bytes

Description: Maximum size in bytes for the Java Process heap memory. Passed to Java -Xmx.
Related Name
Default Value: 8 GiB
API Name: hive_metastore_java_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

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 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: Hive Metastore Max Message Size Validator

Description: Whether to suppress configuration warnings produced by the Hive Metastore Max Message Size Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_hms_max_message_size_validator
Required: true

Suppress Parameter Validation: Base Directory for Hive Proto Hook

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Base Directory for Hive Proto Hook parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hive_hook_proto_base_directory
Required: true

Suppress Parameter Validation: Hive Metastore Server Log Directory

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

Suppress Parameter Validation: Hive Metastore Server Advanced Configuration Snippet (Safety Valve) for hive-site.xml

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

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

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

Suppress Parameter Validation: Hive Metastore Server Filter Hook

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Metastore Server Filter Hook parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hive_metastore_filter_hook
Required: true

Suppress Parameter Validation: Java Configuration Options for Hive Metastore Server

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

Suppress Parameter Validation: Hive Metastore Server Port

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

Suppress Parameter Validation: Metrics Sample File Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Metrics Sample File Location parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hive_metrics_sample_file_location
Required: true

Suppress Parameter Validation: ChangeManager root directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ChangeManager root directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hive_repl_cm_rootdir
Required: true

Suppress Parameter Validation: Hive Metastore 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 Hive Metastore Server Advanced Configuration Snippet (Safety Valve) for core-site.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hms_core_site_safety_valve
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: Hive Metastore Server Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Metastore Server 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: 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 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_hivemetastore_audit_health
Required: true

Suppress Health Test: Hive Metastore Canary

Description: Whether to suppress the results of the Hive Metastore Canary 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_hivemetastore_canary_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_hivemetastore_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_hivemetastore_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_hivemetastore_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_hivemetastore_log_directory_free_space
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_hivemetastore_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_hivemetastore_pause_duration
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_hivemetastore_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_hivemetastore_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_hivemetastore_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_hivemetastore_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_hivemetastore_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_hivemetastore_unexpected_exits
Required: true

HiveServer2

Advanced

HiveServer2 Advanced Configuration Snippet (Safety Valve) for hive-site.xml

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

HiveServer2 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: hive_hs2_env_safety_valve
Required: false

Hive Metastore Connection Retries Count

Description: Number of retries while opening a connection to the Hive Metastore Server
Related Name: hive.metastore.connect.retries
Default Value: 10
API Name: hive_metastore_connection_retries
Required: false

Enable Metrics Subsystem

Description: Controls whether the Hive metrics subsystem is enabled for the role.
Related Name: hive.server2.metrics.enabled
Default Value: true
API Name: hive_metrics_enabled
Required: false

Metrics Sample File Location

Description: The full path to a file with a sample of metrics exposed by the role. The sample is updated at the frequency configured by Metrics Sample File Logging Frequency. By default, the sample file is logged to a directory under the role log directory, e.g., /var/log/hive/metrics-hivemetastore/metrics.log. The setting only has an effect if "Enable Metrics Subsystem" is set to true.
Related Name: hive.service.metrics.file.location
Default Value
API Name: hive_metrics_sample_file_location
Required: false

Metrics Sample File Logging Frequency

Description: The frequency at which the metrics are logged to the sample file. The setting only has an effect if "Enable Metrics Subsystem" is set to true.
Related Name: hive.service.metrics.file.frequency
Default Value: 30 second(s)
API Name: hive_metrics_sample_logging_frequency
Required: false

Hive security authorization SQL Config whitelist append

Description: List of comma separated Java regexes, to be appended to list set in "hive.security.authorization.sqlstd.confwhitelist. Using this list instead of updating the original list means that you can append to the defaults.
Related Name: hive.security.authorization.sqlstd.confwhitelist.append
Default Value
API Name: hive_security_authorization_sqlstd_confwhitelist_append
Required: false

Hive Downloaded Resources Directory

Description: Local directory where Hive stores jars downloaded for remote file systems (HDFS). If not specified, Hive uses a default location.
Related Name: hive.downloaded.resources.dir
Default Value
API Name: hiveserver2_downloaded_resources_dir
Required: false

Enable Explain Logging

Description: When enabled, HiveServer2 logs EXPLAIN EXTENDED output for every query at INFO log4j level.
Related Name: hive.log.explain.output
Default Value: false
API Name: hiveserver2_enable_explain_output
Required: false

Hive Local Scratch Directory

Description: Local Directory where Hive stores jars and data when performing a MapJoin optimization. If not specified, Hive uses a default location.
Related Name: hive.exec.local.scratchdir
Default Value
API Name: hiveserver2_exec_local_scratchdir
Required: false

Hive HDFS Scratch Directory

Description: Directory in HDFS where Hive writes intermediate data between MapReduce jobs. If not specified, Hive uses a default location.
Related Name: hive.exec.scratchdir
Default Value
API Name: hiveserver2_exec_scratchdir
Required: false

Fair Scheduler XML Advanced Configuration Snippet (Safety Valve)

Description: An XML string that will be inserted verbatim into the Fair Scheduler allocations file. This configuration only has effect in CDH 5.8 or later.
Related Name
Default Value
API Name: hiveserver2_fair_scheduler_safety_valve
Required: false

Idle Operation Timeout

Description: Operation will be closed when not accessed for this duration of time, in milliseconds; disable by setting to zero. For a positive value, checked for operations in terminal state only (FINISHED, CANCELED, CLOSED, ERROR). For a negative value, checked for all of the operations regardless of state.
Related Name: hive.server2.idle.operation.timeout
Default Value: 6 hour(s)
API Name: hiveserver2_idle_operation_timeout
Required: false

Idle Session Timeout

Description: Session will be closed when not accessed for this duration of time, in milliseconds; disable by setting to zero or a negative value.
Related Name: hive.server2.idle.session.timeout
Default Value: 1 day(s)
API Name: hiveserver2_idle_session_timeout
Required: false

Exclude Live Operations From Session Idle Time

Description: Session will be considered to be idle only if there is no activity, and there is no pending operation. This setting takes effect only if session idle timeout (hive.server2.idle.session.timeout) and checking (hive.server2.session.check.interval) are enabled.
Related Name: hive.server2.idle.session.check.operation
Default Value: true
API Name: hiveserver2_idle_session_timeout_check_operation
Required: false

Java Configuration Options for HiveServer2

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: JAVA_GC_ARGS
API Name: hiveserver2_java_opts
Required: false

Maximum Query String Length for Show Locks

Description: The maximum length allowed for the query string when the SHOW LOCKS EXTENDED command is executed. Important: The query string is truncated at the length set for this property. Setting this property to a large value puts pressure on ZooKeeper and might cause out-of-memory issues.
Related Name: hive.lock.query.string.max.length
Default Value: 10000
API Name: hiveserver2_lock_query_string_max_length
Required: false

Max HiveServer2 Threads

Description: Maximum number of worker threads in HiveServer2's thread pool
Related Name: hive.server2.thrift.max.worker.threads
Default Value: 500
API Name: hiveserver2_max_threads
Required: true

Min HiveServer2 Threads

Description: Minimum number of worker threads in HiveServer2's thread pool
Related Name: hive.server2.thrift.min.worker.threads
Default Value: 5
API Name: hiveserver2_min_threads
Required: true

Session Check Interval

Description: The check interval for session/operation timeout, in milliseconds, which can be disabled by setting to zero or a negative value.
Related Name: hive.server2.session.check.interval
Default Value: 15 minute(s)
API Name: hiveserver2_session_check_interval
Required: false

HiveServer2 WebUI Max Threads

Description: The max threads for the HiveServer2 WebUI.
Related Name: hive.server2.webui.max.threads
Default Value: 50
API Name: hiveserver2_webui_max_threads
Required: false

HiveServer2 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: hs2_core_site_safety_valve
Required: false

HiveServer2 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

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

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: false
API Name: process_auto_restart
Required: true

Enable Metric Collection

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

Process Start Retry Attempts

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

Process Start Wait Timeout

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

Logs

HiveServer2 Log Directory

Description: Directory where HiveServer2 will place its log files.
Related Name
Default Value: /var/log/hive
API Name: hive_log_dir
Required: false

Enable Performance Logging

Description: When enabled, it captures time spent during each part of the query execution for the role.
Related Name: hive.server2.performance.logging.enabled
Default Value: true
API Name: hive_performance_logging_enabled
Required: false

Enable HiveServer2 Operations Logging

Description: When enabled, HiveServer2 will temporarily save logs associated with ongoing operations. This enables clients like beeline and Hue to request and display logs for a particular ongoing operation. Logs are removed upon completion of operation.
Related Name: hive.server2.logging.operation.enabled
Default Value: true
API Name: hive_server2_logging_operation_enabled
Required: false

HiveServer2 Operations Log Directory

Description: Top level directory where operation logs are temporarily stored if Enable HiveServer2 Operations Logging is true. Logs are stored in session and operation level subdirectories under this location and are removed on completion of operation.
Related Name: hive.server2.logging.operation.log.location
Default Value: /var/log/hive/operation_logs
API Name: hive_server2_logging_operation_log_location
Required: false

HiveServer2 Logging Threshold

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

HiveServer2 Maximum Log File Backups

Description: The maximum number of rolled log files to keep for HiveServer2 logs. Typically used by log4j or logback.
Related Name
Default Value: 10
API Name: max_log_backup_index
Required: false

HiveServer2 Max Log Size

Description: The maximum size, in megabytes, per log file for HiveServer2 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

Hive Downloaded Resources Directory Free Space Monitoring Absolute Thresholds

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

Hive Downloaded Resources Directory Free Space Monitoring Percentage Thresholds

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

Hive Local Scratch Directory Free Space Monitoring Absolute Thresholds

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

Hive Local Scratch Directory Free Space Monitoring Percentage Thresholds

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

HiveServer2 Host Health Test

Description: When computing the overall HiveServer2 health, consider the host's health.
Related Name
Default Value: true
API Name: hiveserver2_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: hiveserver2_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: hiveserver2_pause_duration_window
Required: false

HiveServer2 Process Health Test

Description: Enables the health test that the HiveServer2's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: hiveserver2_scm_health_enabled
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: startDelaySeconds: 10 ssl: false lowercaseOutputName: true lowercaseOutputLabelNames: true rules: - pattern: 'metrics<name=(jvm\.pause.*)><>(.*): (\d+)' name: hive_$1_$2 value: $3
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)'
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: 11121
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: #memory - jvm_buffer_pool_used_bytes - jvm_buffer_pool_capacity_bytes - jvm_buffer_pool_used_buffers - jvm_memory_bytes_used - jvm_memory_bytes_committed - jvm_memory_bytes_max - jvm_memory_bytes_init #gc - jvm_gc_collection_seconds #threads - jvm_threads_current - jvm_threads_daemon - jvm_threads_peak - jvm_threads_started_total - jvm_threads_deadlocked - jvm_threads_deadlocked_monitor - jvm_threads_state #classes - jvm_classes_currently_loaded #process - process_cpu_seconds_total - process_start_time_seconds - process_open_fds - process_virtual_memory_bytes #jvm pause - hive_jvm_pause_extrasleeptime_count
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 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

Swap Memory Usage Rate Thresholds

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

Swap Memory Usage Rate Window

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

Process Swap Memory Thresholds

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

Role Triggers

Description

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

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

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

Related Name

Default Value

[]

API Name

role_triggers

Required

true

Unexpected Exits Thresholds

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

Unexpected Exits Monitoring Period

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

Other

Hive Iceberg data files allow in the table location

Description: If this is set to true, then all the data files being read should be within the table location
Related Name: hive.iceberg.allow.datafiles.in.table.location.only
Default Value: true
API Name: hive_iceberg_allow_datafiles_in_table_location_only
Required: false

Restrict Cross Joins (Cartesian Products)

Description: Whether to allow queries with cross joins. If set to true, queries that contain this pattern throw a compile-time error.
Related Name: hive.strict.checks.cartesian.product
Default Value: false
API Name: hive_restrict_cross_joins
Required: false

Restrict LOAD Queries Against Bucketed Tables

Description: Whether to allow LOAD queries against bucketed tables. If set to true, queries that contain this pattern throw a compile-time error.
Related Name: hive.strict.checks.bucketing
Default Value: true
API Name: hive_restrict_load_bucketed_table
Required: false

Restrict Queries with ORDER BY but no LIMIT clause

Description: Whether to allow queries with an ORDER BY clause, but no LIMIT clause. If set to true, queries that contain this pattern throw a compile-time error.
Related Name: hive.strict.checks.orderby.no.limit
Default Value: false
API Name: hive_restrict_orderby_with_no_limit
Required: false

Restrict Partitioned Table Scans with no Partitioned Column Filter

Description: Whether to allow queries that scan a partitioned table but don't filter on the partition column. If set to true, queries that contain this pattern throw a compile-time error.
Related Name: hive.strict.checks.no.partition.filter
Default Value: false
API Name: hive_restrict_partitioned_scans_no_filter
Required: false

Restrict Unsafe Data Type Comparisons

Description: Whether to allow queries that compare bigints to strings or doubles. If set to true, queries that contain this pattern throw a compile-time error.
Related Name: hive.strict.checks.type.safety
Default Value: true
API Name: hive_restrict_unsafe_comparison
Required: false

HiveServer2 Enable Impersonation

Description: HiveServer2 will impersonate the beeline client user when talking to other services such as MapReduce and HDFS.
Related Name: hive.server2.enable.doAs
Default Value: true
API Name: hiveserver2_enable_impersonation
Required: false

HiveServer2 Load Balancer

Description: Address of the load balancer used for HiveServer2 roles, specified in host:port format. If port is not specified, the port used by HiveServer2 is used. Note: Changing this property regenerates Kerberos keytabs for all HiveServer2 roles.
Related Name
Default Value
API Name: hiveserver2_load_balancer
Required: false

Performance

Hive Auto Convert Join Noconditional Size

Description: If Hive auto convert join is on, and the sum of the size for n-1 of the tables/partitions for a n-way join is smaller than the specified size, the join is directly converted to a MapJoin (there is no conditional task).
Related Name: hive.auto.convert.join.noconditionaltask.size
Default Value: 256 MiB
API Name: hiveserver2_auto_convert_join_noconditionaltask_size
Required: false

Store Intermediate Data on Blobstore

Description: When writing data to a table on a blobstore (such as S3), whether or not the blobstore should be used to store intermediate data during Hive query execution. Setting this to true can degrade performance for queries that spawn multiple MR / Spark jobs, but is useful for queries whose intermediate data cannot fit in the allocated HDFS cluster.
Related Name: hive.blobstore.use.blobstore.as.scratchdir
Default Value: false
API Name: hiveserver2_blobstore_use_blobstore_as_scratchdir
Required: false

Enable Stats Optimization

Description: Enable optimization that checks if a query can be answered using statistics. If so, answers the query using only statistics stored in metastore.
Related Name: hive.compute.query.using.stats
Default Value: true
API Name: hiveserver2_compute_query_using_stats
Required: false

Enable Cost-Based Optimizer for Hive

Description: Enabled the Calcite-based Cost-Based Optimizer for HiveServer2.
Related Name: hive.cbo.enable
Default Value: true
API Name: hiveserver2_enable_cbo
Required: false

Enable MapJoin Optimization

Description: Enable optimization that converts common join into MapJoin based on input file size.
Related Name: hive.auto.convert.join
Default Value: true
API Name: hiveserver2_enable_mapjoin
Required: false

Fetch Task Query Conversion

Description: Some select queries can be converted to a single FETCH task instead of a MapReduce task, minimizing latency. A value of none disables all conversion, minimal converts simple queries such as SELECT * and filter on partition columns, and more converts SELECT queries including FILTERS.
Related Name: hive.fetch.task.conversion
Default Value: more
API Name: hiveserver2_fetch_task_conversion
Required: false

Fetch Task Query Conversion Threshold

Description: Above this size, queries are converted to fetch tasks.
Related Name: hive.fetch.task.conversion.threshold
Default Value: 1 GiB
API Name: hiveserver2_fetch_task_conversion_threshold
Required: false

Number of threads ORC should use to create splits in parallel

Description: If using ORC format and you want improve the split computation time, you can set the value of this parameter to match the number of available processors. By default, this parameter is set to 10. This parameter controls the number of parallel threads involved in computing splits. For Parquet computing splits is still single-threaded, so split computations can take longer with Parquet and Cloud Object Stores.
Related Name: hive.orc.compute.splits.num.threads
Default Value: 10
API Name: hiveserver2_hive_orc_compute_splits_num_threads
Required: false

Input Listing Max Threads

Description: Maximum number of threads that Hive uses to list input files. Increasing this value can improve performance when there are a lot of partitions being read, or when running on blobstores.
Related Name: hive.exec.input.listing.max.threads
Default Value: 15
API Name: hiveserver2_input_listing_max_threads
Required: false

Maximum ReduceSink Top-K Memory Usage

Description: The maximum percentage of heap to be used for hash in ReduceSink operator for Top-K selection. 0 means the optimization is disabled. Accepted values are between 0 and 1.
Related Name: hive.limit.pushdown.memory.usage
Default Value: 0.04
API Name: hiveserver2_limit_pushdown_memory_usage
Required: false

Load Dynamic Partitions Thread Count

Description: Number of threads used to load dynamically generated partitions. Loading requires renaming the file its final location, and updating some metadata about the new partition. Increasing this can improve performance when there are a lot of partitions dynamically generated.
Related Name: hive.load.dynamic.partitions.thread
Default Value: 15
API Name: hiveserver2_load_dynamic_partitions_thread_count
Required: false

Enable Map-Side Aggregation

Description: Enable map-side partial aggregation, which cause the mapper to generate fewer rows. This reduces the data to be sorted and distributed to reducers.
Related Name: hive.map.aggr
Default Value: true
API Name: hiveserver2_map_aggr
Required: false

Ratio of Memory Usage for Map-Side Aggregation

Description: Portion of total memory used in map-side partial aggregation. When exceeded, the partially aggregated results will be flushed from the map task to the reducers.
Related Name: hive.map.aggr.hash.percentmemory
Default Value: 0.5
API Name: hiveserver2_map_aggr_hash_memory_ratio
Required: false

Enable Merging Small Files - Map-Only Job

Description: Merge small files at the end of a map-only job. When enabled, a map-only job is created to merge the files in the destination table/partitions.
Related Name: hive.merge.mapfiles
Default Value: true
API Name: hiveserver2_merge_mapfiles
Required: false

Enable Merging Small Files - Map-Reduce Job

Description: Merge small files at the end of a map-reduce job. When enabled, a map-only job is created to merge the files in the destination table/partitions.
Related Name: hive.merge.mapredfiles
Default Value: false
API Name: hiveserver2_merge_mapredfiles
Required: false

Desired File Size After Merging

Description: The desired file size after merging. This should be larger than hive.merge.smallfiles.avgsize.
Related Name: hive.merge.size.per.task
Default Value: 256 MiB
API Name: hiveserver2_merge_size_per_task
Required: false

Small File Average Size Merge Threshold

Description: When the average output file size of a job is less than the value of this property, Hive will start an additional map-only job to merge the output files into bigger files. This is only done for map-only jobs if hive.merge.mapfiles is true, for map-reduce jobs if hive.merge.mapredfiles is true, and for Spark jobs if hive.merge.sparkfiles is true.
Related Name: hive.merge.smallfiles.avgsize
Default Value: 16 MiB
API Name: hiveserver2_merge_smallfiles_avgsize
Required: false

MSCK Repair Batch Size

Description: Batch size for the msck repair command (recover partitions command). If the value is greater than zero, new partition information will be sent from HiveServer2 to the Metastore in batches, which can potentially improve memory usage in the Metastore and avoid client read timeout exceptions. If this value is 0, all partition information will sent in a single Thrift call.
Related Name: hive.msck.repair.batch.size
Default Value: 3000
API Name: hiveserver2_msck_repair_batch_size
Required: false

Move Files Thread Count

Description: The number of threads used by HiveServer2 to move data from the staging directory to another location (typically to the final table location). A separate thread pool of workers of this size is used for each query, which means this configuration can be set on a per-query basis too.
Related Name: hive.mv.files.thread
Default Value: 15
API Name: hiveserver2_mv_files_thread
Required: false

Hive Optimize Sorted Merge Bucket Join

Description: Whether to try sorted merge bucket (SMB) join.
Related Name: hive.optimize.bucketmapjoin.sortedmerge
Default Value: false
API Name: hiveserver2_optimize_bucketmapjoin_sortedmerge
Required: false

Enable Automatic Use of Indexes

Description: Whether to use the indexing optimization for all queries.
Related Name: hive.optimize.index.filter
Default Value: true
API Name: hiveserver2_optimize_index_filter
Required: false

Enable ReduceDeDuplication Optimization

Description: Remove extra map-reduce jobs if the data is already clustered by the same key, eliminating the need to repartition the dataset again.
Related Name: hive.optimize.reducededuplication
Default Value: true
API Name: hiveserver2_optimize_reducededuplication
Required: false

Mininum Reducers for ReduceDeDuplication Optimization

Description: When the number of ReduceSink operators after merging is less than this number, the ReduceDeDuplication optimization will be disabled.
Related Name: hive.optimize.reducededuplication.min.reducer
Default Value: 4
API Name: hiveserver2_optimize_reducededuplication_min_reducer
Required: false

Enable Sorted Dynamic Partition Optimizer

Description: When dynamic partition is enabled, reducers keep only one record writer at all times, which lowers the memory pressure on reducers.
Related Name: hive.optimize.sort.dynamic.partition
Default Value: false
API Name: hiveserver2_optimize_sort_dynamic_partition
Required: false

Enable Parallel Compilation of Queries

Description: When activated, individual sessions can compile queries simultaneously. Within each session, queries compile one at a time.
Related Name: hive.driver.parallel.compilation
Default Value: true
API Name: hiveserver2_parallel_compilation_enabled
Required: false

Query Compilation Degree of Parallelism

Description: Determines the maximum number of queries that can compile in parallel on a HiveServer2 instance. Use negative values or zero to set unlimited parallelism. Use a positive value to set the number of queries that can compile simultaneously. This setting can be fine-tuned based on the current cluster load. Monitor cluster load using the 'waiting_compile_ops' metric and the 'Waiting Compile Operations' graph in the HiveServer2 graph library.
Related Name: hive.driver.parallel.compilation.global.limit
Default Value: 5
API Name: hiveserver2_parallel_compilation_global_limit
Required: false

Hive SMB Join Cache Rows

Description: The number of rows with the same key value to be cached in memory per SMB-joined table.
Related Name: hive.smbjoin.cache.rows
Default Value: 10000
API Name: hiveserver2_smbjoin_cache_rows
Required: false

Load Column Statistics

Description: Whether column stats for a table are fetched during explain.
Related Name: hive.stats.fetch.column.stats
Default Value: true
API Name: hiveserver2_stats_fetch_column_stats
Required: false

Sessions Per Queue

Description: The number of Tez sessions that should be launched on each of the queues specified by "hive.server2.tez.default.queues". Determines the parallelism on each queue.
Related Name: hive.server2.tez.sessions.per.default.queue
Default Value: 4
API Name: hiveserver2_tez_sessions_per_default_queue
Required: false

Vectorized Adapter Usage Mode

Description: Vectorized Adaptor Usage Mode specifies the extent to which the vectorization engine tries to vectorize UDFs that do not have native vectorized versions available. Selecting the "none" option specifies that only queries using native vectorized UDFs are vectorized. Selecting the "chosen" option specifies that Hive choses to vectorize a subset of the UDFs based on performance benefits using the Vectorized Adaptor. Selecting the "all" option specifies that the Vectorized Adaptor be used for all UDFs even when native vectorized versions are not available.
Related Name: hive.vectorized.adaptor.usage.mode
Default Value: chosen
API Name: hiveserver2_vectorized_adaptor_usage_mode
Required: false

Enable Vectorization Optimization

Description: Enable optimization that vectorizes query execution by streamlining operations by processing a block of 1024 rows at a time.
Related Name: hive.vectorized.execution.enabled
Default Value: true
API Name: hiveserver2_vectorized_enabled
Required: false

Vectorized GroupBy Check Interval

Description: In vectorized group-by, the number of row entries added to the hash table before re-checking average variable size for memory usage estimation.
Related Name: hive.vectorized.groupby.checkinterval
Default Value: 4096
API Name: hiveserver2_vectorized_groupby_checkinterval
Required: false

Vectorized GroupBy Flush Ratio

Description: Ratio between 0.0 and 1.0 of entries in the vectorized group-by aggregation hash that is flushed when the memory threshold is exceeded.
Related Name: hive.vectorized.groupby.flush.percent
Default Value: 0.1
API Name: hiveserver2_vectorized_groupby_flush_ratio
Required: false

Enable Vectorized Input Format

Description: If enabled, Hive uses the native vectorized input format for vectorized query execution when it is available.
Related Name: hive.vectorized.use.vectorized.input.format
Default Value: true
API Name: hiveserver2_vectorized_input_format_enabled
Required: false

Exclude Vectorized Input Formats

Description: Specifies a list of file input format classnames to exclude from vectorized query execution using the vectorized input format. Note that vectorized execution can still occur for an excluded input format based on whether row SerDes or vector SerDes are enabled.
Related Name: hive.vectorized.input.format.excludes
Default Value
API Name: hiveserver2_vectorized_input_format_excludes
Required: false

Enable Reduce-Side Vectorization

Description: Whether to vectorize the reduce side of query execution.
Related Name: hive.vectorized.execution.reduce.enabled
Default Value: true
API Name: hiveserver2_vectorized_reduce_enabled
Required: false

Enable Overflow-checked Vector Expressions

Description: To enhance performance, vectorized expressions operate using wide data types like long and double. When wide data types are used, numeric overflows can occur during expression evaluation in a different manner for vectorized expressions than they do for non-vectorized expressions. Consequently, different query results can be returned for vectorized expressions compared to results returned for non-vectorized expressions. When this configuration is enabled, Hive uses vectorized expressions that handle numeric overflows in the same way as non-vectorized expressions are handled.
Related Name: hive.vectorized.use.checked.expressions
Default Value: true
API Name: hiveserver2_vectorized_use_checked_expressions
Required: false

Vectorize Using Vector SerDes

Description: If enabled, Hive uses built-in vector SerDes to process text and sequencefile tables for vectorized query execution.
Related Name: hive.vectorized.use.vector.serde.deserialize
Default Value: false
API Name: hiveserver2_vectorized_use_vector_serde_deserialize
Required: false

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

Bind HiveServer2 to Wildcard Address

Description: If enabled, the HiveServer2 binds to the wildcard address ("0.0.0.0") on all of its ports.
Related Name: hive.server2.webui.host
Default Value: true
API Name: hiveserver2_webui_bind_wildcard
Required: false

HiveServer2 WebUI Port

Description: The port the HiveServer2 WebUI will listen on. This can be set to 0 to disable the WebUI.
Related Name: hive.server2.webui.port
Default Value: 10002
API Name: hiveserver2_webui_port
Required: false

HiveServer2 Port

Description: Port on which HiveServer2 will listen for connections.
Related Name: hive.server2.thrift.port
Default Value: 10000
API Name: hs2_thrift_address_port
Required: false

Resource Management

Java Heap Size of HiveServer2 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: hiveserver2_java_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

HiveServer2 WebUI SSL Exclude Cipher Suites

Description: The cipher suites should be excluded from WebUI SSL.
Related Name: hive.server2.webui.exclude.ciphersuites
Default Value: modern2018
API Name: hiveserver2_webui_exclude_ciphersuites
Required: false

Enable TLS/SSL for HiveServer2 WebUI

Description: Encrypt communication between clients and HiveServer2 WebUI using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name: hive.server2.webui.use.ssl
Default Value: false
API Name: ssl_enabled
Required: false

HiveServer2 WebUI TLS/SSL Server Keystore File Location

Description: The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when HiveServer2 WebUI is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name: hive.server2.webui.keystore.path
Default Value
API Name: ssl_server_keystore_location
Required: false

HiveServer2 WebUI TLS/SSL Server Keystore File Password

Description: The password for the HiveServer2 WebUI keystore file.
Related Name: hive.server2.webui.keystore.password
Default Value
API Name: ssl_server_keystore_password
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 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: HiveServer2 Advanced Configuration Snippet (Safety Valve) for hive-site.xml

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

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

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

Suppress Parameter Validation: HiveServer2 Log Directory

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

Suppress Parameter Validation: Metrics Sample File Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Metrics Sample File Location parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hive_metrics_sample_file_location
Required: true

Suppress Configuration Validator: Restrict Load Bucketed Table Validator

Description: Whether to suppress configuration warnings produced by the Restrict Load Bucketed Table Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_restrict_load_bucketed_table_validator
Required: true

Suppress Configuration Validator: Restrict Unsafe Comparison Validator

Description: Whether to suppress configuration warnings produced by the Restrict Unsafe Comparison Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_restrict_unsafe_comparison_validator
Required: true

Suppress Parameter Validation: Hive security authorization SQL Config whitelist append

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive security authorization SQL Config whitelist append parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hive_security_authorization_sqlstd_confwhitelist_append
Required: true

Suppress Parameter Validation: HiveServer2 Operations Log Directory

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

Suppress Parameter Validation: Hive Downloaded Resources Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Downloaded Resources Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hiveserver2_downloaded_resources_dir
Required: true

Suppress Parameter Validation: Hive Local Scratch Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Local Scratch Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hiveserver2_exec_local_scratchdir
Required: true

Suppress Parameter Validation: Hive HDFS Scratch Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive HDFS Scratch Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hiveserver2_exec_scratchdir
Required: true

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

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

Suppress Parameter Validation: Java Configuration Options for HiveServer2

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

Suppress Parameter Validation: HiveServer2 Load Balancer

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

Suppress Parameter Validation: Exclude Vectorized Input Formats

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Exclude Vectorized Input Formats parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hiveserver2_vectorized_input_format_excludes
Required: true

Suppress Parameter Validation: HiveServer2 WebUI Port

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

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

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

Suppress Parameter Validation: HiveServer2 Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HiveServer2 Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hs2_thrift_address_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: HiveServer2 Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HiveServer2 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: 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: HiveServer2 WebUI TLS/SSL Server Keystore File Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HiveServer2 WebUI TLS/SSL Server Keystore File Location parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_location
Required: true

Suppress Parameter Validation: HiveServer2 WebUI TLS/SSL Server Keystore File Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HiveServer2 WebUI TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_password
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 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_hiveserver2_audit_health
Required: true

Suppress Health Test: Hive Downloaded Resources Directory Free Space

Description: Whether to suppress the results of the Hive Downloaded Resources 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_hiveserver2_downloaded_resources_directory_free_space
Required: true

Suppress Health Test: Hive Local Scratch Directory Free Space

Description: Whether to suppress the results of the Hive Local Scratch 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_hiveserver2_exec_local_scratch_directory_free_space
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_hiveserver2_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_hiveserver2_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_hiveserver2_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_hiveserver2_log_directory_free_space
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_hiveserver2_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_hiveserver2_pause_duration
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_hiveserver2_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_hiveserver2_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_hiveserver2_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_hiveserver2_unexpected_exits
Required: true

Service-Wide

Advanced

Hive 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

Hive Auxiliary JARs Directory

Description: Directory containing auxiliary JARs used by Hive. This should be a directory location and not a classpath containing one or more JARs. This directory must be created and managed manually on hosts that run the Hive Metastore Server, HiveServer2, or the Hive CLI. The directory location is set in the environment as HIVE_AUX_JARS_PATH and will generally override the hive.aux.jars.path property set in XML files, even if hive.aux.jars.path is set in an advanced configuration snippet.
Related Name
Default Value
API Name: hive_aux_jars_path_dir
Required: false

Bypass Hive Metastore Server

Description: Instead of talking to Hive Metastore Server for Metastore information, Hive clients will talk directly to the Metastore database.
Related Name
Default Value: false
API Name: hive_bypass_metastore_server
Required: false

Hive Service Advanced Configuration Snippet (Safety Valve) for core-site.xml

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

Hive Copy Large File Size

Description: Smaller than this size, Hive uses a single-threaded copy; larger than this size, Hive uses DistCp.
Related Name: hive.exec.copyfile.maxsize
Default Value: 32 MiB
API Name: hive_exec_copyfile_maxsize
Required: false

Hive Replication Environment Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, key-value pairs (one on each line) to be inserted into the environment of Hive replication jobs.
Related Name
Default Value
API Name: hive_replication_env_safety_valve
Required: false

Hive 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: hive_server2_sentry_safety_valve
Required: false

Hive Service Advanced Configuration Snippet (Safety Valve) for hive-site.xml

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

Hive 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: hive_service_env_safety_valve
Required: false

Hive Replication Advanced Configuration Snippet (Safety Valve) for hive-site.xml

Description: For advanced use only, a string to be inserted into hive-site.xml. Applies to all Hive Replication jobs.
Related Name
Default Value
API Name: hive_service_replication_config_safety_valve
Required: false

Hive 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

Hive 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

System Group

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

System User

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

Hive Service Advanced Configuration Snippet (Safety Valve) for ranger-hive-audit.xml

Description: For advanced use only, a string to be inserted into ranger-hive-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

Hive Service Advanced Configuration Snippet (Safety Valve) for ranger-hive-policymgr-ssl.xml

Description: For advanced use only, a string to be inserted into ranger-hive-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

Hive Service Advanced Configuration Snippet (Safety Valve) for ranger-hive-security.xml

Description: For advanced use only, a string to be inserted into ranger-hive-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

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 Hive events:

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

The default Hive audit event filter discards HDFS directory events generated by Hive jobs that reference the /tmp directory.

Related Name

navigator.event.filter

Default Value

comment: [ The default Hive audit event filter discards HDFS directory events , generated by Hive jobs that reference the /tmp directory. ], defaultAction: accept, rules: [ action: discard, fields: [ name: operation, match: QUERY , name: objectType, match: DFS_DIR , name: resourcePath, match: /tmp/hive-(?:.+)?/hive_(?:.+)?/-mr-.* ] ]

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 userNname, 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 Hive events:

operation: the Hive 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 or view affected by the operation.
objectType: the type of object affected by the operation.
resourcePath: the path of the resource affected by 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

Database

Auto Create and Upgrade Hive Metastore Database Schema

Description: Automatically create or upgrade tables in the Hive Metastore database when needed. Consider setting this to false and managing the schema manually.
Related Name: datanucleus.schema.autoCreateAll
Default Value: false
API Name: hive_metastore_database_auto_create_schema
Required: false

Hive Metastore Database DataNucleus Metadata Validation

Description: Perform DataNucleus validation of metadata during startup. Note: when enabled, Hive will log DataNucleus warnings even though Hive will function normally.
Related Name: datanucleus.metadata.xml.validate
Default Value: false
API Name: hive_metastore_database_datanucleus_metadata_validation
Required: false

Enable Direct SQL

Description: Whether Hive Metastore should try to use direct SQL queries instead of DataNucleus for certain read paths. This can improve metastore performance by orders of magnitude when fetching many partitions. In case of failure, execution will fall back to DataNucleus.
Related Name: hive.metastore.try.direct.sql
Default Value: true
API Name: hive_metastore_database_datanucleus_try_direct_sql
Required: false

Hive Metastore Database Host

Description: Host name of Hive Metastore database
Related Name
Default Value: localhost
API Name: hive_metastore_database_host
Required: false

Hive Metastore Database Name

Description: Name of Hive Metastore database
Related Name
Default Value: metastore
API Name: hive_metastore_database_name
Required: false

Hive Metastore Database Password

Description: Password for Hive Metastore database
Related Name: javax.jdo.option.ConnectionPassword
Default Value
API Name: hive_metastore_database_password
Required: false

Hive Metastore Database Port

Description: Port number of Hive Metastore database
Related Name
Default Value: 3306
API Name: hive_metastore_database_port
Required: false

Hive Metastore Database Type

Description: Type of Hive Metastore database. Note that Derby is not recommended and Apache Impala does not support Derby.
Related Name
Default Value: mysql
API Name: hive_metastore_database_type
Required: false

Hive Metastore Database User

Description: User for Hive Metastore database
Related Name: javax.jdo.option.ConnectionUserName
Default Value: hive
API Name: hive_metastore_database_user
Required: false

Hive Metastore Derby Path

Description: Directory name where Hive Metastore's database is stored (only for Derby)
Related Name
Default Value: /var/lib/hive/cloudera_manager/derby/metastore_db
API Name: hive_metastore_derby_path
Required: false

Strict Hive Metastore Schema Validation

Description: Prevent Metastore operations in the event of schema version incompatibility. Consider setting this to true to reduce probability of schema corruption during Metastore operations. Note that setting this property to true will also set datanucleus.autoCreateSchema property to false and datanucleus.fixedDatastore property to true. Any values set in Cloudera Manager for these properties will be overridden.
Related Name: hive.metastore.schema.verification
Default Value: true
API Name: hive_metastore_schema_verification
Required: false

Hive Metastore Database JDBC URL Override

Description: Custom JDBC URL to use when connecting to the Hive Metastore Database. This connection string will override all other values used to construct the JDBC URL, including Hive Metastore Database Host, Hive Metastore Database Name, and Hive Metastore Database Port.
Related Name: javax.jdo.option.ConnectionURL
Default Value
API Name: jdbc_url_override
Required: false

Logs

Audit Log Directory

Description: Path to the directory where audit logs will be written. The directory will be created if it doesn't exist.
Related Name: audit_event_log_dir
Default Value: /var/log/hive/audit
API Name: audit_event_log_dir
Required: false

Hive Lineage Log Directory

Description: The directory in which Hive lineage log files are written.
Related Name: lineage_event_log_dir
Default Value: /var/log/hive/lineage
API Name: lineage_event_log_dir
Required: true

Hive Maximum Lineage Log File Size

Description: The maximum size, in megabytes, per log file for Hive lineage logs. Typically used by log4j or logback.
Related Name: max_lineage_log_file_size
Default Value: 100 MiB
API Name: max_lineage_log_file_size
Required: false

Maximum Audit Log File Size

Description: Maximum size of audit log file in MB before it is rolled over.
Related Name: navigator.audit_log_max_file_size
Default Value: 100 MiB
API Name: navigator_audit_log_max_file_size
Required: false

Number of Audit Logs to Retain

Description: Maximum number of rolled-over audit logs to retain. The logs are not deleted if they contain audit events that have not yet been propagated to the Audit Server.
Related Name: navigator.client.max_num_audit_log
Default Value: 10
API Name: navigator_client_max_num_audit_log
Required: false

Monitoring

Enable Service Level Health Alerts

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

Enable Configuration Change Alerts

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

Oldest Uncleaned Aborted Transaction Thresholds

Description: The health test thresholds for the oldest uncleaned aborted transaction.
Related Name
Default Value: Warning: 1 day(s), Critical: 2 day(s)
API Name: hive_compaction_aborted_txn_not_cleaned_thresholds
Required: false

Tables/Partitions With Many Aborts Thresholds

Description: The health test thresholds for tables/partitions with many aborted transactions.
Related Name
Default Value: Warning: Never, Critical: 1.0 time(s)
API Name: hive_compaction_aborted_txn_thresholds
Required: false

Writes to Tables with Disabled Auto-Compaction Thresholds

Description: The health test thresholds for writes to tables where the auto-compaction is disabled
Related Name
Default Value: Warning: 1.0 time(s), Critical: Never
API Name: hive_compaction_disabled_thresholds
Required: false

Failed Compaction Thresholds

Description: The health test thresholds for the number of failed compactions.
Related Name
Default Value: Warning: 1.0 %, Critical: Never
API Name: hive_compaction_failed_thresholds
Required: false

Hive Compaction Health Test

Description: Enables the health test that checks whether compaction processes are properly configured and operational.
Related Name
Default Value: false
API Name: hive_compaction_health_check_enabled
Required: false

Excessive ACID metadata (CompletedTxnComponents) Thresholds

Description: The health test thresholds for excessive acid metadata in CompletedTxnComponents
Related Name
Default Value: Warning: 500000.0, Critical: 1000000.0
API Name: hive_compaction_metadata_comp_thresholds
Required: false

Excessive ACID metadata (TxnToWriteId) Thresholds

Description: The health test thresholds for excessive acid metadata in TxnToWriteId
Related Name
Default Value: Warning: 500000.0 time(s), Critical: 1000000.0 time(s)
API Name: hive_compaction_metadata_ttw_thresholds
Required: false

Oldest Initiated Compaction Thresholds

Description: The health test thresholds for the oldest initiated compaction.
Related Name
Default Value: Warning: 1 hour(s), Critical: 12 hour(s)
API Name: hive_compaction_oldest_initiated_thresholds
Required: false

Oldest Open replication Transaction Thresholds

Description: The health test thresholds for the oldest open replication transaction
Related Name
Default Value: Warning: 14 day(s), Critical: 21 day(s)
API Name: hive_compaction_oldest_open_repl_txn_thresholds
Required: false

Oldest Open non replication Transaction Thresholds

Description: The health test thresholds for the oldest open non replication transaction
Related Name
Default Value: Warning: 1 day(s), Critical: 3 day(s)
API Name: hive_compaction_oldest_open_txn_thresholds
Required: false

Oldest Uncleaned Compaction Thresholds

Description: The health test thresholds for the oldest uncleaned compaction.
Related Name
Default Value: Warning: 1 day(s), Critical: Never
API Name: hive_compaction_oldest_ready_for_cleaning_thresholds
Required: false

Healthy Hive Metastore Server Monitoring Thresholds

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

Healthy HiveServer2 Monitoring Thresholds

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

Healthy WebHCat Server Monitoring Thresholds

Description: The health test thresholds of the overall WebHCat Server health. The check returns "Concerning" health if the percentage of "Healthy" WebHCat Servers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" WebHCat Servers falls below the critical threshold.
Related Name
Default Value: Warning: 99.0 %, Critical: 51.0 %
API Name: hive_webhcats_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 Client Config Overrides

Description: For advanced use only, a list of configuration properties that will be used by the Service Monitor instead of the current client configuration for the service.
Related Name
Default Value: <property> <name>hive.metastore.client.socket.timeout</name> <value>60</value> </property>
API Name: smon_client_config_overrides
Required: false

Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

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

Other

Atlas Service

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

Generate HADOOP_CREDSTORE_PASSWORD

Description: Flag to enable or disable the generation of HADOOP_CREDSTORE_PASSWORD.
Related Name: generate_jceks_password
Default Value: true
API Name: generate_jceks_password
Required: false

HBase Service

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

HDFS Service

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

Enable Asynchronous Logging

Description: Asynchronous Log4j2 logging can give a significant performance improvement as logging will be handled in a separate thread that uses an LMAX disruptor queue for buffering log messages. Refer to https://logging.apache.org/log4j/2.x/manual/async.html for benefits and drawbacks. For debugging issues we recommend setting this to false.
Related Name: hive.async.log.enabled
Default Value: false
API Name: hive_async_log_enabled
Required: false

Hive Bytes Per Reducer

Description: Size per reducer. If the input size is 10GiB and this is set to 1GiB, Hive will use 10 reducers.
Related Name: hive.exec.reducers.bytes.per.reducer
Default Value: 64 MiB
API Name: hive_bytes_per_reducer
Required: false

Enable Metastore Notifications for DML Operations

Description: When set to true, DML queries from Hive (and SparkSQL for limited use-cases) which insert data into tables will fire listener notifications in the metastore.
Related Name: hive.metastore.dml.events
Default Value: true
API Name: hive_fire_events_for_dml
Required: false

Hive Max Reducers

Description: Max number of reducers to use. If the configuration parameter Hive Reduce Tasks is negative, Hive will limit the number of reducers to the value of this parameter.
Related Name: hive.exec.reducers.max
Default Value: 1009
API Name: hive_max_reducers
Required: false

Hive Reduce Tasks

Description: Default number of reduce tasks per job. Usually set to a prime number close to the number of available hosts. Ignored when mapred.job.tracker is "local". Hadoop sets this to 1 by default, while Hive uses -1 as the default. When set to -1, Hive will automatically determine an appropriate number of reducers for each job.
Related Name: mapred.reduce.tasks
Default Value: -1
API Name: hive_reduce_tasks
Required: false

Enable ChangeManager for Hive replication

Description: When checked, Hive replication will use change management.
Related Name: hive.repl.cm.enabled
Default Value: false
API Name: hive_repl_cm_enabled
Required: false

Support Dynamic Service Discovery

Description: Whether HiveServer2 supports dynamic service discovery for its clients. To support this, each instance of HiveServer2 currently uses ZooKeeper to register itself, when it is brought up. JDBC/ODBC clients should use the ZooKeeper ensemble: hive.zookeeper.quorum in their connection string.
Related Name: hive.server2.support.dynamic.service.discovery
Default Value: true
API Name: hive_server2_support_dynamic_service_discovery
Required: false

Set User and Group Information

Description: In unsecure mode, setting this property to true will cause the Metastore Server to execute DFS operations using the client's reported user and group permissions. Cloudera Manager will set this for all clients and servers.
Related Name: hive.metastore.execute.setugi
Default Value: true
API Name: hive_set_ugi
Required: true

Hive Warehouse Directory

Description: Hive warehouse directory is the location in HDFS where Hive's tables are stored. Note that Hive's default value for its warehouse directory is '/user/hive/warehouse'.
Related Name: hive.metastore.warehouse.dir
Default Value: /warehouse/tablespace/managed/hive
API Name: hive_warehouse_directory
Required: false

Hive External Warehouse Directory

Description: Hive external warehouse directory is the location in HDFS where Hive's tables are stored. Note that Hive's default value for its warehouse directory is '/user/hive/warehouse'.
Related Name: hive.metastore.warehouse.external.dir
Default Value: /warehouse/tablespace/external/hive
API Name: hive_warehouse_external_directory
Required: false

LDAP password

Description: LDAP password for Hive 3 replication
Related Name
Default Value
API Name: hiveserver2_ldap_replication_password
Required: false

LDAP username

Description: LDAP username for Hive 3 replication
Related Name
Default Value
API Name: hiveserver2_ldap_replication_user
Required: false

MapReduce Service

Description: MapReduce jobs are run against this service.
Related Name
Default Value
API Name: mapreduce_yarn_service
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 Hive service instance depends on
Related Name
Default Value
API Name: ranger_service
Required: false

ZooKeeper Service

Description: Name of the ZooKeeper service that this Hive service instance depends on.
Related Name
Default Value
API Name: zookeeper_service
Required: false

Performance

Metastore Bulk Partitions Thread Count

Description: The number of threads the metastore uses when bulk adding partitions to the metastore.. Each thread performs some metadata operations for each partition added, such as collecting statistics for the partition or checking if the partition directory exists. This config is also used to control the size of the threadpool used when scanning the filesystem to look for directories that could correspond to partitions, each thread performs a list status on each possible partition directory.
Related Name: hive.metastore.fshandler.threads
Default Value: 15
API Name: hive_metastore_fshandler_threads
Required: false

Policy File Based Sentry

Sentry User to Group Mapping Class

Description: The class to use in Sentry authorization for user to group mapping. Sentry authorization may be configured to use either Hadoop user to group mapping or local groups defined in the policy file. Hadoop user to group mapping may be configured in the Cloudera Manager HDFS service configuration page under the Security section.
Related Name: hive.sentry.provider
Default Value: org.apache.sentry.provider.file.HadoopGroupResourceAuthorizationProvider
API Name: hive_sentry_provider
Required: false

Sentry Global Policy File

Description: HDFS path to the global policy file for Sentry authorization. This should be a relative path (and not a full HDFS URL). The global policy file must be in Sentry policy file format.
Related Name: hive.sentry.provider.resource
Default Value: /user/hive/sentry/sentry-provider.ini
API Name: hive_sentry_provider_resource
Required: false

Allow URIs in Database Policy File

Description: Allows URIs when defining privileges in per-database policy files. Warning: Typically, this configuration should be disabled. Enabling it would allow database policy file owner (which is generally not Hive admin user) to grant load privileges to any directory with read access to Hive admin user, including databases controlled by other database policy files.
Related Name: sentry.allow.uri.db.policyfile
Default Value: false
API Name: sentry_allow_uri_db_policyfile
Required: false

Proxy

Hive Metastore Access Control and Proxy User Groups Override

Description: This configuration overrides the value set for Hive Proxy User Groups configuration in HDFS service for use by Hive Metastore Server. Specify a comma-delimited list of groups that you want to allow access to Hive Metastore metadata and allow the Hive user to impersonate. A value of '*' allows all groups. The default value of empty inherits the value set for Hive Proxy User Groups configuration in the HDFS service.
Related Name: hadoop.proxyuser.hive.groups
Default Value
API Name: hive_proxy_user_groups_list
Required: false

Hive Metastore Access Control and Ranger RMS Proxy User Hosts

Description: Comma-delimited list of hosts that you want to allow access to Hive Metastore metadata and allow the Ranger RMS user to impersonate other users. The default '*' allows all hosts. To disable entirely, use a string that doesn't correspond to a host name, such as '_no_host'.
Related Name: hadoop.proxyuser.rangerrms.hosts
Default Value: *
API Name: rangerrms_proxy_user_hosts_list
Required: false

Replication

Replica functions root directory

Description: Root directory on the replica warehouse where the repl sub-system will store jars from the primary warehouse
Related Name: hive.repl.replica.functions.root.dir
Default Value
API Name: hive_repl_replica_functions_root_dir
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/hive/atlas-spool
API Name: atlas_message_spool_path
Required: false

Enable LDAP Authentication for Hive Metastore

Description: When checked, LDAP-based authentication for users is enabled.
Related Name
Default Value: false
API Name: hive_metastore_enable_ldap_auth
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: hive.metastore.authentication.ldap.baseDN
Default Value
API Name: hive_metastore_ldap_basedn
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: hive.metastore.authentication.ldap.Domain
Default Value
API Name: hive_metastore_ldap_domain
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: hive.metastore.authentication.ldap.url
Default Value
API Name: hive_metastore_ldap_uri
Required: false

Hive SSL Protocol Blacklist

Description: SSL Versions to disable for all Hive Servers
Related Name: hive.ssl.protocol.blacklist
Default Value: SSLv2, SSLv3, SSLv2Hello, TLSv1, TLSv1.1
API Name: hive_ssl_protocol_blacklist
Required: false

Hive Zookeeper TLS/SSL Server Keystore File Location

Description: The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Hive Zookeeper is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name: hive.zookeeper.ssl.keystore.location
Default Value
API Name: hive_zookeeper_keystore_location
Required: false

Hive Zookeeper TLS/SSL Server Keystore File Password

Description: The password for the Hive Zookeeper keystore file.
Related Name: hive.zookeeper.ssl.keystore.password
Default Value
API Name: hive_zookeeper_keystore_password
Required: false

Enable TLS/SSL for Hive Zookeeper

Description: Encrypt communication between clients and Hive Zookeeper using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name: hive.zookeeper.ssl.client.enable
Default Value: false
API Name: hive_zookeeper_ssl_enable
Required: false

Hive Zookeeper 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 Hive Zookeeper 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: hive.zookeeper.ssl.truststore.location
Default Value
API Name: hive_zookeeper_truststore_location
Required: false

Hive Zookeeper TLS/SSL Trust Store Password

Description: The password for the Hive Zookeeper 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: hive.zookeeper.ssl.truststore.password
Default Value
API Name: hive_zookeeper_truststore_password
Required: false

Enable LDAP Authentication for HiveServer2

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

Enable TLS/SSL for HiveServer2

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

HiveServer2 SSL Exclude Cipher Suites

Description: The cipher suites should be excluded from Hiveserver2 SSL.
Related Name: hive.server2.http.exclude.ciphersuites
Default Value: modern2018
API Name: hiveserver2_exclude_ciphersuites
Required: false

HiveServer2 SSL Include Cipher Suites

Description: The cipher suites should be included in Hiverserver2 SSL.
Related Name: hive.server2.binary.include.ciphersuites
Default Value: modern2018
API Name: hiveserver2_include_ciphersuites
Required: false

HiveServer2 TLS/SSL Server Keystore File Password

Description: The password for the HiveServer2 keystore file.
Related Name: hive.server2.keystore.password
Default Value
API Name: hiveserver2_keystore_password
Required: false

HiveServer2 TLS/SSL Server Keystore File Location

Description: The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when HiveServer2 is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name: hive.server2.keystore.path
Default Value
API Name: hiveserver2_keystore_path
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: hive.server2.authentication.ldap.baseDN
Default Value
API Name: hiveserver2_ldap_basedn
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: hive.server2.authentication.ldap.Domain
Default Value
API Name: hiveserver2_ldap_domain
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: hive.server2.authentication.ldap.url
Default Value
API Name: hiveserver2_ldap_uri
Required: false

HiveServer2 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 HiveServer2 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: hiveserver2_truststore_file
Required: false

HiveServer2 TLS/SSL Trust Store Password

Description: The password for the HiveServer2 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: hiveserver2_truststore_password
Required: false

Kerberos Principal

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

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/hive
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/hive/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/hive/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/hive/policy-cache
API Name: ranger_policy_cache_dir
Required: false

Bypass Sentry Authorization Users

Description: List of users that are allowed to bypass Sentry Authorization in the Hive metastore. These are usually service users that already ensure that all activity has been authorized, such as hive and impala. Only applies when Hive is using Sentry Service.
Related Name: sentry.metastore.service.users
Default Value: hive impala hue hdfs
API Name: sentry_metastore_service_users
Required: false

Hive Metastore 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 Hive Metastore 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: hive.metastore.dbaccess.ssl.truststore.path
Default Value
API Name: ssl_client_truststore_location
Required: false

Hive Metastore TLS/SSL Trust Store Password

Description: The password for the Hive Metastore 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: hive.metastore.dbaccess.ssl.truststore.password
Default Value
API Name: ssl_client_truststore_password
Required: false

Enable TLS/SSL to the Hive Metastore Database

Description: Encrypt communication between Hive Metastore and the database using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). If this is enabled, then the optionally provided Hive Metastore TLS/SSL Client Trust Store properties will be used.
Related Name: hive.metastore.dbaccess.ssl.use.SSL
Default Value: false
API Name: ssl_enabled_database
Required: false

Sentry HDFS Sync Cache

Abort on Initialization Failure

Description: If set to true, the Hive metastore will treat a problem with cache initialization as a fatal error.
Related Name: sentry.hdfs.sync.metastore.cache.fail.on.partial.update
Default Value: true
API Name: sentry_hdfs_sync_metastore_cache_fail_on_partial_update
Required: false

Number of Threads on Initialization

Description: The number of threads used during Hive Metastore Sentry HDFS Sync Cache Initialization.
Related Name: sentry.hdfs.sync.metastore.cache.init.threads
Default Value: 10
API Name: sentry_hdfs_sync_metastore_cache_init_threads
Required: false

Number of Partitions per RPC on Initialization

Description: The number of partitions per RPC retrieved during Hive Metastore Sentry HDFS Sync Cache Initialization.
Related Name: sentry.hdfs.sync.metastore.cache.max-partitions-per-rpc
Default Value: 100
API Name: sentry_hdfs_sync_metastore_cache_partitions_per_rpc
Required: false

Max Number of Retries on Initialization

Description: The maximum number of retries allowed during Hive Metastore Sentry HDFS Sync cache initialization.
Related Name: sentry.hdfs.sync.metastore.cache.retry.max.num
Default Value: 1
API Name: sentry_hdfs_sync_metastore_cache_retry_max_num
Required: false

Retry Wait Time on Initialization

Description: Wait duration in milliseconds for each retry during Hive Metastore Sentry HDFS Sync Cache Initialization.
Related Name: sentry.hdfs.sync.metastore.cache.retry.wait.duration.millis
Default Value: 1 second(s)
API Name: sentry_hdfs_sync_metastore_cache_retry_wait_duration_millis
Required: false

Number of Tables per RPC on Initialization

Description: The number of tables per RPC retrieved during Hive Metastore Sentry HDFS Sync Cache Initialization.
Related Name: sentry.hdfs.sync.metastore.cache.max-tables-per-rpc
Default Value: 100
API Name: sentry_hdfs_sync_metastore_cache_tables_per_rpc
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 Configuration Validator: Deploy Directory

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

Suppress Configuration Validator: WebHCat Server Log Directory

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

Suppress Configuration Validator: Hive Client Advanced Configuration Snippet (Safety Valve) for hive-site.xml

Description: Whether to suppress configuration warnings produced by the Hive Client Advanced Configuration Snippet (Safety Valve) for hive-site.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_client_config_safety_valve
Required: true

Suppress Configuration Validator: Gateway Client Environment Advanced Configuration Snippet (Safety Valve) for hive-env.sh

Description: Whether to suppress configuration warnings produced by the Gateway Client Environment Advanced Configuration Snippet (Safety Valve) for hive-env.sh configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_client_env_safety_valve
Required: true

Suppress Configuration Validator: Client Java Configuration Options

Description: Whether to suppress configuration warnings produced by the Client Java Configuration Options configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_client_java_opts
Required: true

Suppress Configuration Validator: Hive Metastore Max Message Size Validator

Description: Whether to suppress configuration warnings produced by the Hive Metastore Max Message Size Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_hms_max_message_size_validator
Required: true

Suppress Configuration Validator: Base Directory for Hive Proto Hook

Description: Whether to suppress configuration warnings produced by the Base Directory for Hive Proto Hook configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_hook_proto_base_directory
Required: true

Suppress Configuration Validator: HiveServer2 Advanced Configuration Snippet (Safety Valve) for hive-site.xml

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

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

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

Suppress Configuration Validator: Hive Metastore Server Log Directory

Description: Whether to suppress configuration warnings produced by the Hive Metastore Server Log Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_log_dir
Required: true

Suppress Configuration Validator: Hive Metastore Server Advanced Configuration Snippet (Safety Valve) for hive-site.xml

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

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

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

Suppress Configuration Validator: Hive Metastore Server Filter Hook

Description: Whether to suppress configuration warnings produced by the Hive Metastore Server Filter Hook configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_metastore_filter_hook
Required: true

Suppress Configuration Validator: Java Configuration Options for Hive Metastore Server

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

Suppress Configuration Validator: Hive Metastore Server Port

Description: Whether to suppress configuration warnings produced by the Hive Metastore Server Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_metastore_port
Required: true

Suppress Configuration Validator: Metrics Sample File Location

Description: Whether to suppress configuration warnings produced by the Metrics Sample File Location configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_metrics_sample_file_location
Required: true

Suppress Configuration Validator: ChangeManager root directory

Description: Whether to suppress configuration warnings produced by the ChangeManager root directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_repl_cm_rootdir
Required: true

Suppress Configuration Validator: Restrict Load Bucketed Table Validator

Description: Whether to suppress configuration warnings produced by the Restrict Load Bucketed Table Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_restrict_load_bucketed_table_validator
Required: true

Suppress Configuration Validator: Restrict Unsafe Comparison Validator

Description: Whether to suppress configuration warnings produced by the Restrict Unsafe Comparison Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_restrict_unsafe_comparison_validator
Required: true

Suppress Configuration Validator: Hive security authorization SQL Config whitelist append

Description: Whether to suppress configuration warnings produced by the Hive security authorization SQL Config whitelist append configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hive_security_authorization_sqlstd_confwhitelist_append
Required: true

Suppress Configuration Validator: HiveServer2 Operations Log Directory

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

Suppress Configuration Validator: WebHCat Server Port

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

Suppress Configuration Validator: WebHCat Server Advanced Configuration Snippet (Safety Valve) for webhcat-site.xml

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

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

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

Suppress Configuration Validator: WebHCat Server Advanced Configuration Snippet (Safety Valve) for hive-site.xml

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

Suppress Configuration Validator: Java Configuration Options for WebHCat Server

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

Suppress Configuration Validator: Hive Downloaded Resources Directory

Description: Whether to suppress configuration warnings produced by the Hive Downloaded Resources Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hiveserver2_downloaded_resources_dir
Required: true

Suppress Configuration Validator: Hive Local Scratch Directory

Description: Whether to suppress configuration warnings produced by the Hive Local Scratch Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hiveserver2_exec_local_scratchdir
Required: true

Suppress Configuration Validator: Hive HDFS Scratch Directory

Description: Whether to suppress configuration warnings produced by the Hive HDFS Scratch Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hiveserver2_exec_scratchdir
Required: true

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

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

Suppress Configuration Validator: Java Configuration Options for HiveServer2

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

Suppress Configuration Validator: HiveServer2 Load Balancer

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

Suppress Configuration Validator: Exclude Vectorized Input Formats

Description: Whether to suppress configuration warnings produced by the Exclude Vectorized Input Formats configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hiveserver2_vectorized_input_format_excludes
Required: true

Suppress Configuration Validator: HiveServer2 WebUI Port

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

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

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

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

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

Suppress Configuration Validator: HiveServer2 Port

Description: Whether to suppress configuration warnings produced by the HiveServer2 Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hs2_thrift_address_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: Gateway Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Gateway 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: 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: HiveServer2 WebUI TLS/SSL Server Keystore File Location

Description: Whether to suppress configuration warnings produced by the HiveServer2 WebUI TLS/SSL Server Keystore File Location configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_location
Required: true

Suppress Configuration Validator: HiveServer2 WebUI TLS/SSL Server Keystore File Password

Description: Whether to suppress configuration warnings produced by the HiveServer2 WebUI TLS/SSL Server Keystore File Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_password
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: WebHCat Server Advanced Configuration Snippet (Safety Valve) for core-site.xml

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

Suppress Parameter Validation: Hive 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 Hive 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 Parameter Validation: Audit Log Directory

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

Suppress Configuration Validator: Gateway Count Validator

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

Suppress Parameter Validation: Hive Auxiliary JARs Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Auxiliary JARs Directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hive_aux_jars_path_dir
Required: true

Suppress Configuration Validator: Hive Bypass Metastore Validator

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

Suppress Configuration Validator: Client TLS/SSL In Use With LDAP Authentication Validator

Description: Whether to suppress configuration warnings produced by the Client TLS/SSL In Use With LDAP Authentication Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_hive_client_ssl_recommended_with_ldap_auth_validator
Required: true

Suppress Configuration Validator: Hive Concurrency Configuration Validator

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

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

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

Suppress Configuration Validator: Hive Derby Validator

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

Suppress Parameter Validation: Hive Metastore Database Host

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

Suppress Parameter Validation: Hive Metastore Database Name

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Metastore Database Name parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hive_metastore_database_name
Required: true

Suppress Parameter Validation: Hive Metastore Database Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Metastore Database Password parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hive_metastore_database_password
Required: true

Suppress Parameter Validation: Hive Metastore Database Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Metastore Database Port parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hive_metastore_database_port
Required: true

Suppress Configuration Validator: Database TLS with JDBC URL Override Validator

Description: Whether to suppress configuration warnings produced by the Database TLS with JDBC URL Override Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_hive_metastore_database_tls_overridden_by_jdbc_url_validator
Required: true

Suppress Parameter Validation: Hive Metastore Database User

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

Suppress Parameter Validation: Hive Metastore Derby Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Metastore Derby Path parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hive_metastore_derby_path
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_hive_metastore_ldap_basedn
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_hive_metastore_ldap_domain
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_hive_metastore_ldap_uri
Required: true

Suppress Configuration Validator: Legacy HS2 Validator

Description: Whether to suppress configuration warnings produced by the Legacy HS2 Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_hive_no_legacy_hs2_validator
Required: true

Suppress Configuration Validator: Hive Proxy Groups Validator

Description: Whether to suppress configuration warnings produced by the Hive Proxy Groups Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_hive_proxy_groups_validator
Required: true

Suppress Parameter Validation: Hive Metastore Access Control and Proxy User Groups Override

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Metastore Access Control and Proxy User Groups Override parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hive_proxy_user_groups_list
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 Configuration Validator: Hive Ranger Validator

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

Suppress Parameter Validation: Replica functions root directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Replica functions root directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hive_repl_replica_functions_root_dir
Required: true

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

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

Suppress Parameter Validation: Sentry Global Policy File

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Sentry Global Policy File parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hive_sentry_provider_resource
Required: true

Suppress Configuration Validator: Hive Sentry Validator

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

Suppress Parameter Validation: Hive 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 Hive Service Advanced Configuration Snippet (Safety Valve) for sentry-site.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hive_server2_sentry_safety_valve
Required: true

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

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

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

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

Suppress Parameter Validation: Hive Replication Advanced Configuration Snippet (Safety Valve) for hive-site.xml

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

Suppress Parameter Validation: Hive SSL Protocol Blacklist

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive SSL Protocol Blacklist parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hive_ssl_protocol_blacklist
Required: true

Suppress Parameter Validation: Hive Warehouse Directory

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

Suppress Parameter Validation: Hive External Warehouse Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive External Warehouse Directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hive_warehouse_external_directory
Required: true

Suppress Parameter Validation: Hive Zookeeper TLS/SSL Server Keystore File Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Zookeeper TLS/SSL Server Keystore File Location parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hive_zookeeper_keystore_location
Required: true

Suppress Parameter Validation: Hive Zookeeper TLS/SSL Server Keystore File Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Zookeeper TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hive_zookeeper_keystore_password
Required: true

Suppress Parameter Validation: Hive Zookeeper TLS/SSL Trust Store File

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

Suppress Parameter Validation: Hive Zookeeper TLS/SSL Trust Store Password

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

Suppress Configuration Validator: Hive Metastore Server Count Validator

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

Suppress Configuration Validator: HiveServer2 Count Validator

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

Suppress Parameter Validation: HiveServer2 TLS/SSL Server Keystore File Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HiveServer2 TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hiveserver2_keystore_password
Required: true

Suppress Parameter Validation: HiveServer2 TLS/SSL Server Keystore File Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HiveServer2 TLS/SSL Server Keystore File Location parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hiveserver2_keystore_path
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_hiveserver2_ldap_basedn
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_hiveserver2_ldap_domain
Required: true

Suppress Parameter Validation: LDAP password

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

Suppress Parameter Validation: LDAP username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP username parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hiveserver2_ldap_replication_user
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_hiveserver2_ldap_uri
Required: true

Suppress Parameter Validation: HiveServer2 TLS/SSL Trust Store File

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

Suppress Parameter Validation: HiveServer2 TLS/SSL Trust Store Password

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

Suppress Parameter Validation: Hive Metastore Database JDBC URL Override

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Metastore Database JDBC URL Override parameter.
Related Name
Default Value: false
API Name: service_config_suppression_jdbc_url_override
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: Hive Lineage Log Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Lineage Log Directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_lineage_event_log_dir
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: Hive 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 Hive 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: Hive 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 Hive 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 Parameter Validation: System Group

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

Suppress Parameter Validation: System User

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

Suppress Parameter Validation: 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: Hive Service Advanced Configuration Snippet (Safety Valve) for ranger-hive-audit.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Service Advanced Configuration Snippet (Safety Valve) for ranger-hive-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: Hive Service Advanced Configuration Snippet (Safety Valve) for ranger-hive-policymgr-ssl.xml

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

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

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

Suppress Parameter Validation: Hive Metastore Access Control and Ranger RMS Proxy User Hosts

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Metastore Access Control and Ranger RMS Proxy User Hosts parameter.
Related Name
Default Value: false
API Name: service_config_suppression_rangerrms_proxy_user_hosts_list
Required: true

Suppress Parameter Validation: Bypass Sentry Authorization Users

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Bypass Sentry Authorization Users parameter.
Related Name
Default Value: false
API Name: service_config_suppression_sentry_metastore_service_users
Required: true

Suppress Parameter Validation: Service Triggers

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

Suppress Parameter Validation: Service Monitor Client Config Overrides

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Client Config Overrides parameter.
Related Name
Default Value: false
API Name: service_config_suppression_smon_client_config_overrides
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: Hive Metastore TLS/SSL Trust Store File

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

Suppress Parameter Validation: Hive Metastore TLS/SSL Trust Store Password

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

Suppress Configuration Validator: WebHCat Server Count Validator

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

Suppress Health Test: Compaction System Health Check

Description: Whether to suppress the results of the Compaction System Health 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: service_health_suppression_hive_compaction_health
Required: true

Suppress Health Test: Hive Metastore Server Health

Description: Whether to suppress the results of the Hive Metastore 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_hive_hivemetastores_healthy
Required: true

Suppress Health Test: HiveServer2 Health

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

Suppress Health Test: WebHCat Server Health

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

WebHCat Server

Advanced

WebHCat Server Advanced Configuration Snippet (Safety Valve) for webhcat-site.xml

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

WebHCat 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: hive_webhcat_env_safety_valve
Required: false

WebHCat Server Advanced Configuration Snippet (Safety Valve) for hive-site.xml

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

Java Configuration Options for WebHCat 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: JAVA_GC_ARGS
API Name: hive_webhcat_java_opts
Required: false

WebHCat Server 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

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

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: false
API Name: process_auto_restart
Required: true

Enable Metric Collection

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

Process Start Retry Attempts

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

Process Start Wait Timeout

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

WebHCat 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: webhcat_core_site_safety_valve
Required: false

Logs

WebHCat Server Log Directory

Description: Directory where WebHCat Server will place its log files.
Related Name
Default Value: /var/log/hcatalog
API Name: hcatalog_log_dir
Required: false

WebHCat Server Logging Threshold

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

WebHCat Server Maximum Log File Backups

Description: The maximum number of rolled log files to keep for WebHCat Server logs. Typically used by log4j or logback.
Related Name
Default Value: 10
API Name: max_log_backup_index
Required: false

WebHCat Server Max Log Size

Description: The maximum size, in megabytes, per log file for WebHCat Server 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

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: startDelaySeconds: 10 ssl: false lowercaseOutputName: true lowercaseOutputLabelNames: true rules: - pattern: '^nothing-should-match-this$'
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)'
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
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: #memory - jvm_buffer_pool_used_bytes - jvm_buffer_pool_capacity_bytes - jvm_buffer_pool_used_buffers - jvm_memory_bytes_used - jvm_memory_bytes_committed - jvm_memory_bytes_max - jvm_memory_bytes_init #gc - jvm_gc_collection_seconds #threads - jvm_threads_current - jvm_threads_daemon - jvm_threads_peak - jvm_threads_started_total - jvm_threads_deadlocked - jvm_threads_deadlocked_monitor - jvm_threads_state #classes - jvm_classes_currently_loaded #process - process_cpu_seconds_total - process_start_time_seconds - process_open_fds - process_virtual_memory_bytes
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
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

Swap Memory Usage Rate Thresholds

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

Swap Memory Usage Rate Window

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

Process Swap Memory Thresholds

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

Role Triggers

Description

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

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

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

Related Name

Default Value

[]

API Name

role_triggers

Required

true

Unexpected Exits Thresholds

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

Unexpected Exits Monitoring Period

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

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

WebHCat Server Host Health Test

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

WebHCat Server Process Health Test

Description: Enables the health test that the WebHCat Server's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: webhcat_scm_health_enabled
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

WebHCat Server Port

Description: Port on which WebHCat Server will listen for connections.
Related Name: templeton.port
Default Value: 50111
API Name: hive_webhcat_address_port
Required: false

Resource Management

Java Heap Size of WebHCat Server in Bytes

Description: Maximum size in bytes for the Java Process heap memory. Passed to Java -Xmx.
Related Name
Default Value: 256 MiB
API Name: hive_webhcat_java_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

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 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: WebHCat Server Log Directory

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

Suppress Parameter Validation: WebHCat Server Port

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

Suppress Parameter Validation: WebHCat Server Advanced Configuration Snippet (Safety Valve) for webhcat-site.xml

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

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

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

Suppress Parameter Validation: WebHCat Server Advanced Configuration Snippet (Safety Valve) for hive-site.xml

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

Suppress Parameter Validation: Java Configuration Options for WebHCat Server

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Configuration Options for WebHCat Server parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hive_webhcat_java_opts
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: WebHCat Server Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the WebHCat Server 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: 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: WebHCat 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 WebHCat Server Advanced Configuration Snippet (Safety Valve) for core-site.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_webhcat_core_site_safety_valve
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_webhcat_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_webhcat_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_webhcat_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_webhcat_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_webhcat_log_directory_free_space
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_webhcat_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_webhcat_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_webhcat_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_webhcat_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_webhcat_unexpected_exits
Required: true