TCP port (on each cluster host) to be used for P2P Parcel Distribution. Set to 0 to disable P2P Parcel Distribution. This setting should only be modified when no parcels are being distributed.
For advanced use only, key-value pairs (one on each line) used by Cloudera Manager Agent.
Related Name
Default Value
API Name
host_agent_safety_valve
Required
false
Java Home Directory
Description
Explicitly set the value of JAVA_HOME for all processes. This will override the auto-detection logic that is normally used.
Related Name
Default Value
API Name
java_home
Required
false
Data Services: Restrict workloads types
Description
Select Dedicated GPU Node for CAI service when the host has Nvidia GPU.
If Dedicated GPU Node is selected, this host will be reserved for workloads requiring GPU resources.
Should only be used if this host has Nvidia GPU drivers installed.
Select Dedicated NVMe Node for Data Warehouse service when the host has NVMe for caching.
If Dedicated NVMe Node is selected, this host will be reserved for workloads requiring NVMe resources.
Select Dedicated CDE Node for Data Engineering services (select only if ECS version is 1.5.5 SP2 or above).
If Dedicated CDE Node is selected, the host will be reserved for all CDE-related services and workloads.
Select Dedicated CAI Infra for CAI infrastructure services (select only if ECS version is 1.5.5 SP2 or above).
If Dedicated CAI Infra is selected, the host will be allocated exclusively for scheduling CAI infrastructure services.
Select None if none of the above options apply.
This will be the default value.
These selections are applicable only for hosts that will be used in a Data Services Cluster.
Certain workloads are scheduled to run on all nodes. If the taint was applied after CDP was installed, those workloads will not be drained from tainted nodes.
Related Name
Default Value
None
API Name
node_taint
Required
false
Host Upgrade Domain
Description
For advanced use only, the HDFS Upgrade Domain that a host belongs to. Only applies to DataNode hosts. Any DataNode hosts without an Upgrade Domain set will default to using the rack assignment of the host. This setting is not used if the Upgrade Domains block placement policy is not enabled for HDFS.
Related Name
upgrade_domain
Default Value
API Name
upgrade_domain
Required
false
Monitoring
Enable Health Alerts for This Host
Description
When set, Cloudera Manager will send alerts when the health of this host reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
Related Name
Default Value
false
API Name
enable_alerts
Required
false
Enable Configuration Change Alerts
Description
When set, Cloudera Manager will send alerts when this entity's configuration changes.
Cloudera Manager Agent Log Directory Free Space Monitoring Percentage Thresholds
Description
The health check thresholds for monitoring of free space on the filesystem that contains the Cloudera Manager Agent's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Cloudera Manager Agent Log Directory Free Space Monitoring Absolute Thresholds setting is configured.
Cloudera Manager Agent Parcel Directory Free Space Monitoring Percentage Thresholds
Description
The health check thresholds for monitoring of free space on the filesystem that contains the Cloudera Manager Agent's parcel directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Cloudera Manager Agent Parcel Directory Free Space Monitoring Absolute Thresholds setting is configured.
Cloudera Manager Agent Process Directory Free Space Monitoring Percentage Thresholds
Description
The health check thresholds for monitoring of free space on the filesystem that contains the Cloudera Manager Agent's process directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Cloudera Manager Agent Process Directory Free Space Monitoring Absolute Thresholds setting is configured.
The health check thresholds for the available entropy on the host.
Related Name
Default Value
Warning: 100.0, Critical: 50.0
API Name
host_available_entropy_thresholds
Required
false
Host Clock Offset Thresholds
Description
The thresholds for the host clock offset health test. The test compares this threshold against the absolute value of the clock offset reported by the host's NTP service from the 'ntpdc -np' or 'chronyc sources' command. Setting both the warning and critical threshold values to never turns off collection of the clock offset by the Cloudera Manager Agent. If no time synchronization is in use, both threshold values should be set to never. Cloudera recommends using NTP for time synchronization of Hadoop clusters.
Related Name
Default Value
Warning: 3 second(s), Critical: 10 second(s)
API Name
host_clock_offset_thresholds
Required
false
Default Process Swap Memory Thresholds
Description
The default health test thresholds on the swap memory usage of the processes on the host. This value is used if process level threshold is equal to the default.
Related Name
Default Value
Warning: 200.0 page(s), Critical: Never
API Name
host_default_proc_memswap_thresholds
Required
false
Disk Device Collection Exclusion Regex
Description
The regular expression used to filter monitored disk devices and partitions. Disk device (for example, sda) and partition (for example, sda2) names that match this pattern will be excluded from metric collection.
Related Name
Default Value
^$
API Name
host_disk_collection_filter
Required
false
Host DNS Resolution Duration Thresholds
Description
The health check thresholds for the host DNS resolution duration.
Related Name
Default Value
Warning: 1 second(s), Critical: Never
API Name
host_dns_resolution_duration_thresholds
Required
false
Hostname and Canonical Name Health Check
Description
Whether the hostname and canonical names for this host are consistent when checked from a Java process.
Related Name
Default Value
true
API Name
host_dns_resolution_enabled
Required
false
Filesystem Check Error Exclusion Regex
Description
The regular expression used to filter filesystem check errors. Filesystem check errors that match this pattern will be put into debug log level.
Related Name
Default Value
^((/run/user/[0-9])|(/var/lib/kubernetes/*))
API Name
host_filesystem_check_error_filter
Required
false
Filesystem Collection Exclusion Regex
Description
The regular expression used to filter monitored filesystems. Mountpoints for filesystems (for example, /data/1) that match this pattern will be excluded from metric collection.
Related Name
Default Value
^$
API Name
host_fs_collection_filter
Required
false
Host Memory Swapping Thresholds
Description
The health test thresholds of the number of pages swapped out on the host in the last 15 minutes
Related Name
Default Value
Warning: 200.0 page(s), Critical: Never
API Name
host_memswap_thresholds
Required
false
Host Memory Swapping Check Window
Description
The amount of time over which the memory swapping test checks for pages swapped.
Related Name
Default Value
15 minute(s)
API Name
host_memswap_window
Required
false
Host Network Frame Error Test Minimum Required Packets
Description
The minimum number of received packets that must be received within the test window for this test to return "Bad" health. If less that this number of packets is received during the test window, the health check will never return "Bad" health.
Related Name
Default Value
0
API Name
host_network_frame_errors_floor
Required
false
Host Network Frame Error Percentage Thresholds
Description
The health check thresholds for the percentage of received packets that are frame errors.
Related Name
Default Value
Warning: Any, Critical: 0.5 %
API Name
host_network_frame_errors_thresholds
Required
false
Host Network Frame Error Check Window
Description
The amount of time over which the host frame error checks for frame errors.
Related Name
Default Value
15 minute(s)
API Name
host_network_frame_errors_window
Required
false
Network Interface Collection Exclusion Regex
Description
The regular expression used to filter monitored network interfaces. Network interfaces that match this pattern will be excluded from metric collection.
Related Name
Default Value
^(lo|bond[0-9]*)$
API Name
host_network_interface_collection_filter
Required
false
Host's Network Interfaces Slow Link Modes Thresholds
Description
The thresholds for the health check of the number of network interfaces that appear to be operating at less than full speed.
Related Name
Default Value
Warning: Any, Critical: Never
API Name
host_network_interfaces_slow_mode_thresholds
Required
false
Network Interface Expected Duplex Mode
Description
The expected duplex mode for network interfaces.
Related Name
Default Value
Full
API Name
host_nic_expected_duplex_mode
Required
false
Network Interface Expected Link Speed
Description
The expected network interface link speed.
Related Name
Default Value
1000
API Name
host_nic_expected_speed
Required
false
Host Process Health Test
Description
Enables the health test that the host's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
host_scm_health_enabled
Required
false
Host Triggers
Description
The configured triggers for this host. 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 host.
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 the host wait time exceeds 500 ms:[{"triggerName": "sample-trigger",
"triggerExpression": "IF (select await_time where hostname=$HOSTNAME and last(await_time) > 500ms) DO health:concerning",
"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
host_triggers
Required
true
OpenTelemetry Collector Connectors Section
Description
Defines the connectors as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
For advanced use only, key-value pairs (one on each line) to be inserted into the OpenTelemetry Collector runtime environment.
Related Name
Default Value
API Name
otelcol_env_safety_valve
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.
Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
OpenTelemetry Collector Gateway Exporter for Jobs / Queries
Description
Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
OpenTelemetry Collector Gateway Exporter for metrics
Description
Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
The list of hosts which should be used as gateways for exporting telemetry data. These should be valid host name(s) which are part of the cluster. The provided hosts will be used for substituting $GATEWAY_HOST in the otelcol_exporter configs.
Related Name
Default Value
API Name
otelcol_gateway_hosts
Required
false
OpenTelemetry Collector Gateway Internal Exporter
Description
Define the gateway internal exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
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, $GATEWAY_HOST, $GATEWAY_PORT 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.
Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Defines the port number on which the gateway OpenTelemetry Collectors should listen for incoming logs and metrics.
Related Name
Default Value
4320
API Name
otelcol_gateway_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.
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.
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
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.
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
OpenTelemetry Collector Self Telemetry Section
Description
The OpenTelemetry Collector Self Telemetry provides information about its state for monitoring purposes. It requires a port where it publishes its metrics. This port will only be used if a role on the host requires OpenTelemetry Collector to run. See 'otelcol' related settings for services and roles. See the OpenTelemetry documentation.
The directory that parcels will be installed into on the host(s). The download 'parcel-cache' directory will be placed next to this directory on the filesystem. If the 'parcel_dir' variable is set in the Agent's config.ini file, it will override this value.
Related Name
Default Value
/opt/cloudera/parcels
API Name
parcels_directory
Required
true
Resource Management
Memory Overcommit Validation Threshold
Description
Threshold used when validating the allocation of RAM on a host. 0 means all of the memory is reserved for the system. 1 means none is reserved. Values can range from 0 to 1.
Related Name
Default Value
0.8
API Name
memory_overcommit_threshold
Required
false
Enable Cgroup-based Resource Management
Description
Enables resource management using control groups (cgroups). When toggled, roles on the host must be restarted for cgroups to be enabled or disabled. Per-resource controls are found in the configuration pages of role configuration groups and individual roles. Control groups are a feature of the Linux kernel, and support varies by distribution; see the Cloudera Manager documentation for details.
Related Name
Default Value
false
API Name
rm_enabled
Required
true
Suppressions
Suppress Configuration Validator: Cloudera Manager Agent User and Group Validator
Description
Whether to suppress configuration warnings produced by the Cloudera Manager Agent User and Group Validator configuration validator.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Cloudera Manager Agent Monitoring Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
host_config_suppression_host_agent_safety_valve
Required
true
Suppress Parameter Validation: Disk Device Collection Exclusion Regex
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Disk Device Collection Exclusion Regex parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Network Interface Collection Exclusion Regex parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Environment Advanced Configuration Snippet (Safety Valve) parameter.
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
host_config_suppression_otelcol_extensions
Required
true
Suppress Parameter Validation: OpenTelemetry Collector Gateway Exporter for Jobs / Queries
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Gateway Exporter for Jobs / Queries parameter.
Suppress Parameter Validation: OpenTelemetry Collector Gateway Exporter for metrics
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Gateway Exporter for metrics parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Gateway Internal Exporter parameter.
Suppress Parameter Validation: OpenTelemetry Collector Gateway Logs Service
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Gateway Logs Service parameter.
Suppress Parameter Validation: OpenTelemetry Collector Gateway Metrics Service
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Gateway Metrics Service parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Password parameter.
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
host_config_suppression_otelcol_remote_write_user
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.
Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Self Telemetry Section parameter.
Related Name
Default Value
false
API Name
host_config_suppression_otelcol_telemetry
Required
true
Suppress Parameter Validation: Parcel Directory
Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Parcel Directory parameter.
Whether to suppress configuration warnings produced by the built-in parameter validation for the Host Upgrade Domain parameter.
Related Name
Default Value
false
API Name
host_config_suppression_upgrade_domain
Required
true
Suppress Health Test: Certificate Expiration
Description
Whether to suppress the results of the Certificate Expiration 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.
Whether to suppress the results of the Agent Log Directory 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.
Whether to suppress the results of the Agent Parcel Directory 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.
Whether to suppress the results of the Agent Process Directory 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.
Whether to suppress the results of the Entropy 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
host_health_suppression_host_available_entropy
Required
true
Suppress Health Test: Clock Offset
Description
Whether to suppress the results of the Clock Offset 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
host_health_suppression_host_clock_offset
Required
true
Suppress Health Test: DNS Resolution
Description
Whether to suppress the results of the DNS Resolution 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
host_health_suppression_host_dns_resolution
Required
true
Suppress Health Test: Swapping
Description
Whether to suppress the results of the Swapping 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
host_health_suppression_host_memory_swapping
Required
true
Suppress Health Test: Frame Errors
Description
Whether to suppress the results of the Frame Errors 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
host_health_suppression_host_network_frame_errors
Required
true
Suppress Health Test: Network Interface Speed
Description
Whether to suppress the results of the Network Interface Speed 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.
Whether to suppress the results of the Agent 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.
