Cloudera Management Service

Role groups:

Activity Monitor

Advanced

Activity Monitor 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
ACTIVITYMONITOR_role_env_safety_valve
Required
false

Event Publication Maximum Queue Size

Description
The maximum size of the queue in which events published from this role will be buffered. If this queue becomes full (for example, due to an outage), subsequent events will be dropped.
Related Name
activityevents.event.publish.queue.max
Default Value
20000
API Name
actmon_event_publication_queue_size_max
Required
true

Event Publication Retry Period

Description
If an event cannot be delivered immediately by this role, this value controls how long to wait before Event Publisher retries delivery.
Related Name
activityevents.event.publish.retry.ms
Default Value
5000
API Name
actmon_event_publication_retry_period
Required
true

Java Configuration Options for Activity Monitor

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

Activity Monitor Advanced Configuration Snippet (Safety Valve) for cmon.conf

Description
For advanced use only. A string to be inserted into cmon.conf for this role only.
Related Name
Default Value
API Name
firehose_safety_valve
Required
false

Activity Monitor 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

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 heap dump file when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value
true
API Name
oom_heap_dump_enabled
Required
true

Kill When Out of Memory

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

Automatically Restart Process

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

Enable Metric Collection

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

Process Start Retry Attempts

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

Process Start Wait Timeout

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

Database

Activity Monitor Database Hostname

Description
Name of host where Activity Monitor's database is running. It is highly recommended that this database is on the same host as the Activity Monitor. If the database is not running on its default port, specify the port number using this syntax: 'host:port'
Related Name
Default Value
localhost
API Name
firehose_database_host
Required
false

Activity Monitor Database Name

Description
Name of the Activity Monitor's database.
Related Name
Default Value
firehose
API Name
firehose_database_name
Required
true

Activity Monitor Database Password

Description
Password for logging in to the Activity Monitor database
Related Name
db.hibernate.connection.password
Default Value
API Name
firehose_database_password
Required
false

Activity Monitor Database Type

Description
Type of database to use for Activity Monitor.
Related Name
Default Value
mysql
API Name
firehose_database_type
Required
false

Activity Monitor Database Username

Description
Username for logging in to the Activity Monitor database.
Related Name
db.hibernate.connection.username
Default Value
firehose
API Name
firehose_database_user
Required
true

Logs

Activity Monitor Logging Threshold

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

Activity Monitor Maximum Log File Backups

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

Activity Monitor Max Log Size

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

Activity Monitor Log Directory

Description
Location of log files for Activity Monitor
Related Name
Default Value
/var/log/cloudera-scm-firehose
API Name
mgmt_log_dir
Required
false

Monitoring

Activity Monitor Activity Monitor Pipeline Monitoring Thresholds

Description
The health test thresholds for monitoring the Activity Monitor activity monitor pipeline. This specifies the number of dropped messages that will be tolerated over the monitoring time period.
Related Name
Default Value
Warning: Never, Critical: Any
API Name
activitymonitor_activity_monitor_pipeline_thresholds
Required
false

Activity Monitor Activity Monitor Pipeline Monitoring Time Period

Description
The time period over which the Activity Monitor activity monitor pipeline will be monitored for dropped messages.
Related Name
Default Value
5 minute(s)
API Name
activitymonitor_activity_monitor_pipeline_window
Required
false

Activity Monitor Activity Tree Pipeline Monitoring Thresholds

Description
The health test thresholds for monitoring the Activity Monitor activity tree pipeline. This specifies the number of dropped messages that will be tolerated over the monitoring time period.
Related Name
Default Value
Warning: Never, Critical: Any
API Name
activitymonitor_activity_tree_pipeline_thresholds
Required
false

Activity Monitor Activity Tree Pipeline Monitoring Time Period

Description
The time period over which the Activity Monitor activity tree pipeline will be monitored for dropped messages.
Related Name
Default Value
5 minute(s)
API Name
activitymonitor_activity_tree_pipeline_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
activitymonitor_fd_thresholds
Required
false

Activity Monitor Host Health Test

Description
When computing the overall Activity Monitor health, consider the host's health.
Related Name
Default Value
true
API Name
activitymonitor_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
activitymonitor_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
activitymonitor_pause_duration_window
Required
false

Activity Monitor Process Health Test

Description
Enables the health test that the Activity Monitor's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
activitymonitor_scm_health_enabled
Required
false

Web Metric Collection

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

Web Metric Collection Duration

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

Enable Health Alerts for this Role

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

Enable Configuration Change Alerts

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

Heap Dump Directory Free Space Monitoring Absolute Thresholds

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

Heap Dump Directory Free Space Monitoring Percentage Thresholds

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

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

Rules to Extract Events from Log Files

Description
This file contains the rules that govern how log messages are turned into events by the custom log4j appender that this role loads. It is in JSON format, and is composed of a list of rules. Every log message is evaluated against each of these rules in turn to decide whether or not to send an event for that message. If a log message matches multiple rules, the first matching rule is used.. Each rule has some or all of the following fields:
  • alert - whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".
  • rate (mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more than rate matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.
  • periodminutes - the number of minutes during which the publisher will only publish rate events or fewer. If not specified, the default is one minute
  • threshold - apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.
  • content - match only those messages for which contents match this regular expression.
  • exceptiontype - match only those messages that are part of an exception message. The exception type must match this regular expression.
Example:
  • {"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}This rule sends events to Cloudera Manager for every StringIndexOutOfBoundsException, up to a maximum of 10 every minute.
  • {"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.
Related Name
Default Value
version: 0, rules: [ alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Instead, use .* , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Use .* instead , alert: false, rate: 1, periodminutes: 1, threshold: FATAL , alert: false, rate: 1, periodminutes: 2, exceptiontype: .* , alert: false, rate: 1, periodminutes: 1, threshold: WARN ]
API Name
log_event_whitelist
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

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

Cloudera Manager Descriptor Age Thresholds

Description
The health test thresholds for monitoring the time since the Cloudera Manager descriptor was last refreshed.
Related Name
Default Value
Warning: 60000.0, Critical: 120000.0
API Name
scm_descriptor_age_thresholds
Required
false

Unexpected Exits Thresholds

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

Unexpected Exits Monitoring Period

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

Other

Event Publication Log Quiet Time Period

Description
To avoid producing excessive amounts of log output, the Event Publisher component of this role is limited to emitting one message per time period. This value controls the size of that time period.
Related Name
activityevents.event.publish.log.suppress.window.ms
Default Value
1 minute(s)
API Name
actmon_event_publication_log_suppress_window
Required
true

Use the Authentication Service to enable Single Sign On

Description
Use the Authentication Service to enable Single Sign On for the Firehose debug servers. Requires a running Authentication Service.
Related Name
debug.servlet.auth.enabled
Default Value
false
API Name
debug_servlet_auth_enabled
Required
false

Purge Activities Data at This Age

Description
In Activity Monitor, purge data about MapReduce jobs and aggregate activities when the data reaches this age in hours. By default, Activity Monitor keeps data about activities for 336 hours (14 days).
Related Name
firehose.activity.purge.duration.hours
Default Value
14 day(s)
API Name
firehose_activity_purge_duration_hours
Required
false

Purge Attempts Data at This Age

Description
In the Activity Monitor, purge data about MapReduce attempts when the data reaches this age in hours. Because attempt data may consume large amounts of database space, you may wish to purge it more frequently than activity data. By default, Activity Monitor keeps data about attempts for 336 hours (14 days).
Related Name
firehose.attempt.purge.duration.hours
Default Value
14 day(s)
API Name
firehose_attempt_purge_duration_hours
Required
false

Starting Interval for Descriptor Fetch Attempts

Description
The starting interval between fetch attempts for the SCM descriptor when Cloudera Management Service roles are starting. The interval is increased by an additional one second with each failed fetch attempt.
Related Name
mgmt.descriptor.fetch.frequency
Default Value
2 second(s)
API Name
mgmt_descriptor_fetch_frequency
Required
true

Descriptor Fetch Max Attempts

Description
Maximum number of attempts to fetch the SCM descriptor when Cloudera Management Service roles are starting. If the roles are not able to get the descriptor in this number of attempts, then the roles exit.
Related Name
mgmt.num.descriptor.fetch.tries
Default Value
10
API Name
mgmt_num_descriptor_fetch_tries
Required
true

Purge MapReduce Service Data at This Age

Description
The number of hours of past service-level data to keep in the Activity Monitor database, such as total slots running. The default is to keep data for 336 hours (14 days).
Related Name
timeseries.expiration.hours
Default Value
14 day(s)
API Name
timeseries_expiration_hours
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

Bind Activity Monitor to Wildcard Address

Description
If enabled, the Activity Monitor binds to the wildcard address ("0.0.0.0") on all of its ports.
Related Name
Default Value
false
API Name
amon_bind_wildcard
Required
false

Activity Monitor Web UI Port

Description
Port for Activity Monitor's Debug page. Set to -1 to disable the debug server.
Related Name
debug.servlet.port
Default Value
8087
API Name
firehose_debug_port
Required
false

Activity Monitor Web UI HTTPS Port

Description
Port for Activity Monitor's HTTPS Debug page.
Related Name
debug.servlet.https.port
Default Value
9087
API Name
firehose_debug_tls_port
Required
false

Activity Monitor Listen Port

Description
Port where Activity Monitor is listening for agent messages.
Related Name
firehose.server.port
Default Value
9999
API Name
firehose_listen_port
Required
false

Activity Monitor Nozzle Port

Description
Port where Activity Monitor's query API is exposed.
Related Name
nozzle.server.port
Default Value
9998
API Name
firehose_nozzle_port
Required
false

Resource Management

Java Heap Size of Activity Monitor in Bytes

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

Cgroup CPU Shares

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

Custom Control Group Resources (overrides Cgroup settings)

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

Cgroup I/O Weight

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

Cgroup Memory Hard Limit

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

Cgroup Memory Soft Limit

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

Security

Activity Monitor Kerberos Principal

Description
Kerberos principal used by the Activity Monitor. Note: Activity Monitoring should always use the principal used by Hue service.
Related Name
Default Value
hue
API Name
kerberos_role_princ_name
Required
true

Enable TLS/SSL for Firehose Debug Server

Description
Encrypt communication between clients and Firehose Debug Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name
debug.servlet.https.enabled
Default Value
false
API Name
ssl_enabled
Required
false

Firehose Debug Server 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 Firehose Debug Server is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name
debug.servlet.https.keystorePath
Default Value
API Name
ssl_server_keystore_location
Required
false

Firehose Debug Server TLS/SSL Server Keystore File Password

Description
The password for the Firehose Debug Server keystore file.
Related Name
debug.servlet.https.keystorePassword
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 Parameter Validation: Activity Monitor Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Configuration Validator: CDH Version Validator

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

Suppress Parameter Validation: Activity Monitor Database Hostname

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Activity Monitor Database Hostname parameter.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_database_host
Required
true

Suppress Parameter Validation: Activity Monitor Database Name

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Activity Monitor Database Name parameter.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_database_name
Required
true

Suppress Parameter Validation: Activity Monitor Database Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Activity Monitor Database Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_database_password
Required
true

Suppress Parameter Validation: Activity Monitor Database Username

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Activity Monitor Database Username parameter.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_database_user
Required
true

Suppress Parameter Validation: Activity Monitor Web UI Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Activity Monitor Web UI Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_debug_port
Required
true

Suppress Parameter Validation: Activity Monitor Web UI HTTPS Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Activity Monitor Web UI HTTPS Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_debug_tls_port
Required
true

Suppress Parameter Validation: Java Configuration Options for Activity Monitor

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

Suppress Parameter Validation: Activity Monitor Listen Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Activity Monitor Listen Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_listen_port
Required
true

Suppress Parameter Validation: Activity Monitor Nozzle Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Activity Monitor Nozzle Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_nozzle_port
Required
true

Suppress Parameter Validation: Activity Monitor Advanced Configuration Snippet (Safety Valve) for cmon.conf

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Activity Monitor Advanced Configuration Snippet (Safety Valve) for cmon.conf parameter.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_safety_valve
Required
true

Suppress Parameter Validation: Activity Monitor Kerberos Principal

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

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

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Activity Monitor 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: Rules to Extract Events from Log Files

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Rules to Extract Events from Log Files parameter.
Related Name
Default Value
false
API Name
role_config_suppression_log_event_whitelist
Required
true

Suppress Parameter Validation: Activity Monitor Log Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Activity Monitor Log Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_mgmt_log_dir
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: 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: Firehose Debug Server TLS/SSL Server Keystore File Location

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

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Firehose Debug Server 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: Activity Monitor Pipeline

Description
Whether to suppress the results of the Activity Monitor Pipeline 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_activity_monitor_activity_monitor_pipeline
Required
true

Suppress Health Test: Activity Tree Pipeline

Description
Whether to suppress the results of the Activity Tree Pipeline 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_activity_monitor_activity_tree_pipeline
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_activity_monitor_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_activity_monitor_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_activity_monitor_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_activity_monitor_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_activity_monitor_log_directory_free_space
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_activity_monitor_pause_duration
Required
true

Suppress Health Test: Cloudera Manager Descriptor Age

Description
Whether to suppress the results of the Cloudera Manager Descriptor Age 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_activity_monitor_scm_descriptor_fetch
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_activity_monitor_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_activity_monitor_swap_memory_usage
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_activity_monitor_unexpected_exits
Required
true

Suppress Health Test: Web Server Status

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

Alert Publisher

Advanced

Java Configuration Options for Alert Publisher

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

Alert Publisher 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
ALERTPUBLISHER_role_env_safety_valve
Required
false

Alert Publisher Advanced Configuration Snippet (Safety Valve) for alertpublisher.conf

Description
For advanced use only. A string to be inserted into alertpublisher.conf for this role only.
Related Name
Default Value
API Name
alertpublisher_safety_valve
Required
false

Alert Publisher 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

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 heap dump file when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value
true
API Name
oom_heap_dump_enabled
Required
true

Kill When Out of Memory

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

Automatically Restart Process

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

Enable Metric Collection

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

Process Start Retry Attempts

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

Process Start Wait Timeout

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

Logs

Alert Publisher Logging Threshold

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

Alert Publisher Maximum Log File Backups

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

Alert Publisher Max Log Size

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

Alert Publisher Log Directory

Description
Directory where Alert Publisher will place its log files.
Related Name
Default Value
/var/log/cloudera-scm-alertpublisher
API Name
mgmt_log_dir
Required
false

Monitoring

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
alertpublisher_fd_thresholds
Required
false

Alert Publisher Host Health Test

Description
When computing the overall Alert Publisher health, consider the host's health.
Related Name
Default Value
true
API Name
alertpublisher_host_health_enabled
Required
false

Alert Publisher Process Health Test

Description
Enables the health test that the Alert Publisher's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
alertpublisher_scm_health_enabled
Required
false

Enable Health Alerts for this Role

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

Enable Configuration Change Alerts

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

Heap Dump Directory Free Space Monitoring Absolute Thresholds

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

Heap Dump Directory Free Space Monitoring Percentage Thresholds

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

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

Rules to Extract Events from Log Files

Description
This file contains the rules that govern how log messages are turned into events by the custom log4j appender that this role loads. It is in JSON format, and is composed of a list of rules. Every log message is evaluated against each of these rules in turn to decide whether or not to send an event for that message. If a log message matches multiple rules, the first matching rule is used.. Each rule has some or all of the following fields:
  • alert - whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".
  • rate (mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more than rate matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.
  • periodminutes - the number of minutes during which the publisher will only publish rate events or fewer. If not specified, the default is one minute
  • threshold - apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.
  • content - match only those messages for which contents match this regular expression.
  • exceptiontype - match only those messages that are part of an exception message. The exception type must match this regular expression.
Example:
  • {"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}This rule sends events to Cloudera Manager for every StringIndexOutOfBoundsException, up to a maximum of 10 every minute.
  • {"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.
Related Name
Default Value
version: 0, rules: [ alert: false, rate: 1, periodminutes: 1, threshold: FATAL , alert: false, rate: 1, periodminutes: 2, exceptiontype: .* , alert: false, rate: 1, periodminutes: 1, threshold: WARN ]
API Name
log_event_whitelist
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

Process Swap Memory Thresholds

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

Role Triggers

Description
The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
Related Name
Default Value
[]
API Name
role_triggers
Required
true

Unexpected Exits Thresholds

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

Unexpected Exits Monitoring Period

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

Other

Alerts: Enable Email Alerts

Description
This setting allows you to turn email alert delivery on and off.
Related Name
mailserver.enabled
Default Value
true
API Name
alert_mailserver_enabled
Required
false

Alert: Mail From Address

Description
The 'From' address to use for alert emails
Related Name
Default Value
noreply@localhost
API Name
alert_mailserver_from_address
Required
false

Alerts: Mail Server Hostname

Description
The IP address or hostname of the mail server to send alerts to
Related Name
Default Value
localhost
API Name
alert_mailserver_hostname
Required
true

Alerts: Mail Server Password

Description
The password to use to log into the mail server. Warning: this password will be sent over the network to the Alert Publisher host in clear text. In addition, the password will be stored in a plain text file on the Alert Publisher host with restrictive file system permissions.
Related Name
Default Value
API Name
alert_mailserver_password
Required
false

Alerts: Mail Server Protocol

Description
The protocol to use for sending email alerts.
Related Name
Default Value
smtp
API Name
alert_mailserver_protocol
Required
true

Alerts: Mail Message Recipients

Description
A comma-separated list of email addresses to send alerts to
Related Name
Default Value
root@localhost
API Name
alert_mailserver_recipients
Required
true

Alerts: Mail Server Username

Description
The username to use to log into the mail server
Related Name
Default Value
API Name
alert_mailserver_username
Required
false

Custom Alert Script

Description
If configured, this script is invoked on the machine hosting the alert publisher role. The script must be readable and executable by the cloudera-scm user. The script is passed, as a single argument, a path to a UTF-8 JSON file containing a list of alerts. Alerts are, by default, batched over time, and the batch size and the batch interval are configurable with the "Alert Publisher: Maximum Batch Size" and "Alert Publisher: Maximum Batch Interval" configuration options. The alerts file is deleted when the script finishes executing. Only one instance of this script is invoked at any given time, and the script must terminate. The standard out and standard error messages from this script are logged to the alert publisher role's log file.
Related Name
alert.script.path
Default Value
API Name
alert_script_path
Required
false

Alert Publisher: Maximum Batch Size

Description
The Alert Publisher can be configured to batch multiple alerts into a single email. This setting specifies the maximum number of alerts that will be batched into a single email (regardless of the batch interval).
Related Name
alert.aggregate.maxSize
Default Value
32
API Name
alertpublisher_aggregate_max_size
Required
false

Alert Publisher: Maximum Batch Interval

Description
The Alert Publisher can be configured to batch multiple alerts into a single email. This setting specifies the maximum amount of time (in milliseconds) that the Alert Publisher waits before sending an email of the current batch.
Related Name
alert.aggregate.timeout.millis
Default Value
1 minute(s)
API Name
alertpublisher_aggregate_timeout
Required
false

Alerts: Email footer

Description
Optional. If not empty, the text entered here will be inserted verbatim as a footer in HTML and plain-text emails.
Related Name
alert.email.footer
Default Value
API Name
alertpublisher_email_footer
Required
false

Alerts: Email header

Description
Optional. If not empty, the text entered here will be inserted verbatim as a header in HTML and plain-text emails.
Related Name
alert.email.header
Default Value
API Name
alertpublisher_email_header
Required
false

Alerts: Mail Message Format

Description
The format of the email alert message. The 'JSON' format is easy for scripts/programs to parse. The 'HTML' and 'text' formats are designed to be easily read by people.
Related Name
mail.format
Default Value
html
API Name
mail_format
Required
true

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

Alerts: Mail Server TCP Port

Description
Optional. The TCP port where the mail server is listening. If not specified, defaults to 25 if SMTP is selected, or 465 if SMTPS is selected.
Related Name
Default Value
API Name
alert_mailserver_port
Required
false

Alerts: Listen Port

Description
Port where the Alert Publisher listens for internal API requests.
Related Name
alertpublisher.internalapi.port
Default Value
10101
API Name
alertpublisher_internalapi_port
Required
false

Resource Management

Java Heap Size of Alert Publisher 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
alert_heapsize
Required
false

Cgroup CPU Shares

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

Custom Control Group Resources (overrides Cgroup settings)

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

Cgroup I/O Weight

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

Cgroup Memory Hard Limit

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

Cgroup Memory Soft Limit

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

SNMP

SNMP Authentication Protocol Pass Phrase

Description
Pass phrase to use for SNMP authentication protocol
Related Name
alert.snmp.auth.password
Default Value
API Name
alert_snmp_auth_password
Required
false

SNMP Authentication Protocol

Description
Authentication algorithm to use for authentication
Related Name
alert.snmp.auth.protocol
Default Value
SHA
API Name
alert_snmp_auth_protocol
Required
false

SNMPv2 Community String

Description
Community string to use to identify this service. Generated SNMPv2 traps will use this string for authentication purpose.
Related Name
alert.snmp.community
Default Value
API Name
alert_snmp_community
Required
false

SNMP Retry Count

Description
Number of time to try before trap is timed out. If this value is set to '0' the trap will be sent only once.
Related Name
alert.snmp.retries
Default Value
0
API Name
alert_snmp_retries
Required
true

SNMP Server Engine Id

Description
Engine Id to use for authentication and privacy. Engine Id is normally a hexadecimal number (e.g. 8000173e03a0c095f80c68). Engine Id along with pass phrases are used to generate keys for authentication and privacy protocols.
Related Name
alert.snmp.security.engineid
Default Value
API Name
alert_snmp_security_engineid
Required
false

SNMP Security Level

Description
Level of security to use for SNMP v3 protocol. Currently only 'no authentication' and 'authentication with no privacy' is supported. Select 'SNMPv2' to use 'Community String' based SNMPv2 authentication.
Related Name
alert.snmp.security.level
Default Value
SNMPv2
API Name
alert_snmp_security_level
Required
true

SNMP NMS Hostname

Description
Hostname of the SNMP NMS (network management software). It can be a DNS name or IP address of the host listening for SNMP traps and notifications. For reference, here is Cloudera Manager SNMP Mib .
Related Name
alert.snmp.server.hostname
Default Value
API Name
alert_snmp_server_hostname
Required
false

SNMP Server Port

Description
Port number on which SNMP server is listening.
Related Name
alert.snmp.server.port
Default Value
162
API Name
alert_snmp_server_port
Required
true

SNMP Timeout

Description
Time to wait before an SNMP trap is resent or timed out.
Related Name
alert.snmp.timeout
Default Value
5 second(s)
API Name
alert_snmp_timeout
Required
true

SNMP Security UserName

Description
Name of a user to use for SNMP security.
Related Name
alert.snmp.username
Default Value
API Name
alert_snmp_username
Required
false

Stacks Collection

Stacks Collection Data Retention

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

Stacks Collection Directory

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

Stacks Collection Enabled

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

Stacks Collection Frequency

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

Stacks Collection Method

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

Suppressions

Suppress Parameter Validation: Alert: Mail From Address

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

Suppress Parameter Validation: Alerts: Mail Server Hostname

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Alerts: Mail Server Hostname parameter.
Related Name
Default Value
false
API Name
role_config_suppression_alert_mailserver_hostname
Required
true

Suppress Parameter Validation: Alerts: Mail Server Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Alerts: Mail Server Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_alert_mailserver_password
Required
true

Suppress Parameter Validation: Alerts: Mail Server TCP Port

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

Suppress Parameter Validation: Alerts: Mail Message Recipients

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Alerts: Mail Message Recipients parameter.
Related Name
Default Value
false
API Name
role_config_suppression_alert_mailserver_recipients
Required
true

Suppress Parameter Validation: Alerts: Mail Server Username

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

Suppress Parameter Validation: Custom Alert Script

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Alert Script parameter.
Related Name
Default Value
false
API Name
role_config_suppression_alert_script_path
Required
true

Suppress Parameter Validation: SNMP Authentication Protocol Pass Phrase

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SNMP Authentication Protocol Pass Phrase parameter.
Related Name
Default Value
false
API Name
role_config_suppression_alert_snmp_auth_password
Required
true

Suppress Parameter Validation: SNMPv2 Community String

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SNMPv2 Community String parameter.
Related Name
Default Value
false
API Name
role_config_suppression_alert_snmp_community
Required
true

Suppress Parameter Validation: SNMP Server Engine Id

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SNMP Server Engine Id parameter.
Related Name
Default Value
false
API Name
role_config_suppression_alert_snmp_security_engineid
Required
true

Suppress Parameter Validation: SNMP NMS Hostname

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SNMP NMS Hostname parameter.
Related Name
Default Value
false
API Name
role_config_suppression_alert_snmp_server_hostname
Required
true

Suppress Parameter Validation: SNMP Server Port

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

Suppress Parameter Validation: SNMP Security UserName

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SNMP Security UserName parameter.
Related Name
Default Value
false
API Name
role_config_suppression_alert_snmp_username
Required
true

Suppress Parameter Validation: Alerts: Email footer

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Alerts: Email footer parameter.
Related Name
Default Value
false
API Name
role_config_suppression_alertpublisher_email_footer
Required
true

Suppress Parameter Validation: Alerts: Email header

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Alerts: Email header parameter.
Related Name
Default Value
false
API Name
role_config_suppression_alertpublisher_email_header
Required
true

Suppress Parameter Validation: Alerts: Listen Port

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

Suppress Parameter Validation: Java Configuration Options for Alert Publisher

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

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

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

Suppress Parameter Validation: Alert Publisher Advanced Configuration Snippet (Safety Valve) for alertpublisher.conf

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Alert Publisher Advanced Configuration Snippet (Safety Valve) for alertpublisher.conf parameter.
Related Name
Default Value
false
API Name
role_config_suppression_alertpublisher_safety_valve
Required
true

Suppress Configuration Validator: CDH Version Validator

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

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

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Alert Publisher 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: Rules to Extract Events from Log Files

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Rules to Extract Events from Log Files parameter.
Related Name
Default Value
false
API Name
role_config_suppression_log_event_whitelist
Required
true

Suppress Parameter Validation: Alert Publisher Log Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Alert Publisher Log Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_mgmt_log_dir
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: 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 Configuration Validator: SNMP Validator

Description
Whether to suppress configuration warnings produced by the SNMP Validator configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_snmp_validator
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_alert_publisher_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_alert_publisher_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_alert_publisher_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_alert_publisher_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_alert_publisher_log_directory_free_space
Required
true

Suppress Health Test: Process Status

Description
Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_alert_publisher_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_alert_publisher_swap_memory_usage
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_alert_publisher_unexpected_exits
Required
true

Event Server

Advanced

Java Configuration Options for Event Server

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

Maximum Number of Events Returned by Any Query

Description
The maximum number of events that any query can return. Note: A high value can increase the amount of memory required by Event Server, as well as affect query response times.
Related Name
eventcatcher.max.query.events
Default Value
10000
API Name
eventserver_max_query_events
Required
true

Maximum Write Queue Length

Description
The maximum number of events that can be queued for write before further requests are rejected
Related Name
eventcatcher.ingest.pipeline.max
Default Value
10000
API Name
eventserver_max_write_queue_size
Required
true

Number of Core Event Writer Threads

Description
The number of threads that Event Server will use to write events to its store concurrently
Related Name
eventcatcher.num.ingest.threads
Default Value
2
API Name
eventserver_num_pipeline_threads
Required
true

Event Server Query Timeout

Description
The amount of time, in milliseconds, that Cloudera Manager and the Alert Publisher will wait for the Event Server to respond to a query.
Related Name
eventserver.query.timeout
Default Value
60000
API Name
eventserver_query_timeout
Required
false

Event 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
EVENTSERVER_role_env_safety_valve
Required
false

Event Server Advanced Configuration Snippet (Safety Valve) for eventserver.conf

Description
For advanced use only. A string to be inserted into eventserver.conf for this role only.
Related Name
Default Value
API Name
eventserver_safety_valve
Required
false

Event 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

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 heap dump file when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value
true
API Name
oom_heap_dump_enabled
Required
true

Kill When Out of Memory

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

Automatically Restart Process

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

Enable Metric Collection

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

Process Start Retry Attempts

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

Process Start Wait Timeout

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

Logs

Event Server Logging Threshold

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

Event Server Maximum Log File Backups

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

Event Server Max Log Size

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

Event Server Log Directory

Description
Directory where Event Server will place its log files.
Related Name
Default Value
/var/log/cloudera-scm-eventserver
API Name
mgmt_log_dir
Required
false

Monitoring

Enable Health Alerts for this Role

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

Enable Configuration Change Alerts

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

Event Store Capacity Monitoring Thresholds

Description
The health test thresholds on the number of events in the event store. Specified as a percentage of the maximum number of events in Event Server store.
Related Name
Default Value
Warning: 115.0 %, Critical: 130.0 %
API Name
eventserver_capacity_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
eventserver_fd_thresholds
Required
false

Garbage Collection Duration Thresholds

Description
The health test thresholds for the weighted average time spent in Java garbage collection. Specified as a percentage of elapsed wall clock time.
Related Name
Default Value
Warning: 30.0, Critical: 60.0
API Name
eventserver_gc_duration_thresholds
Required
false

Garbage Collection Duration Monitoring Period

Description
The period to review when computing the moving average of garbage collection time.
Related Name
Default Value
5 minute(s)
API Name
eventserver_gc_duration_window
Required
false

Event Server Host Health Test

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

Event Server Index Directory Free Space Monitoring Absolute Thresholds

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

Event Server Index Directory Free Space Monitoring Percentage Thresholds

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

Event Server Process Health Test

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

Web Metric Collection

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

Web Metric Collection Duration

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

Event Server Write Pipeline Monitoring Thresholds

Description
The health test thresholds for monitoring the Event Server write pipeline. This specifies the number of dropped messages that will be tolerated over the monitoring time period.
Related Name
Default Value
Warning: Never, Critical: Any
API Name
eventserver_write_pipeline_thresholds
Required
false

Event Server Write Pipeline Monitoring Time Period

Description
The time period over which the Event Server write pipeline will be monitored for dropped messages.
Related Name
Default Value
5 minute(s)
API Name
eventserver_write_pipeline_window
Required
false

Heap Dump Directory Free Space Monitoring Absolute Thresholds

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

Heap Dump Directory Free Space Monitoring Percentage Thresholds

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

Log Directory Free Space Monitoring Absolute Thresholds

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

Log Directory Free Space Monitoring Percentage Thresholds

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

Rules to Extract Events from Log Files

Description
This file contains the rules that govern how log messages are turned into events by the custom log4j appender that this role loads. It is in JSON format, and is composed of a list of rules. Every log message is evaluated against each of these rules in turn to decide whether or not to send an event for that message. If a log message matches multiple rules, the first matching rule is used.. Each rule has some or all of the following fields:
  • alert - whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".
  • rate (mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more than rate matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.
  • periodminutes - the number of minutes during which the publisher will only publish rate events or fewer. If not specified, the default is one minute
  • threshold - apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.
  • content - match only those messages for which contents match this regular expression.
  • exceptiontype - match only those messages that are part of an exception message. The exception type must match this regular expression.
Example:
  • {"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}This rule sends events to Cloudera Manager for every StringIndexOutOfBoundsException, up to a maximum of 10 every minute.
  • {"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.
Related Name
Default Value
version: 0, rules: [ alert: false, rate: 1, periodminutes: 1, threshold: FATAL , alert: false, rate: 1, periodminutes: 2, exceptiontype: .* , alert: false, rate: 1, periodminutes: 1, threshold: WARN ]
API Name
log_event_whitelist
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

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

Cloudera Manager Descriptor Age Thresholds

Description
The health test thresholds for monitoring the time since the Cloudera Manager descriptor was last refreshed.
Related Name
Default Value
Warning: 60000.0, Critical: 120000.0
API Name
scm_descriptor_age_thresholds
Required
false

Unexpected Exits Thresholds

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

Unexpected Exits Monitoring Period

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

Other

Alert On Transitions Out of Alerting Health

Description
If set, the health events for transitions out of an alertable health level will also be considered an alert. For example, consider an entity that is configured to alert when it has bad health. If that entity's health becomes bad, an alert will be generated. If this setting is enabled, an alert will also be generated when it returns to good health. If this setting is disabled, then no alert will be generated when it returns to good health. Note that an entity must have enable_alerts set to true for health alerts to be generated for it. And make sure to reference the per-entity setting to turn on health alerts.
Related Name
Default Value
false
API Name
eventserver_alert_on_transition_out_of_alerting_health_enabled
Required
false

Health Alert Threshold

Description
Threshold at which a health event will be considered an alert. Note that an entity must have enable_alerts set to true for health alerts to be generated for it. And make sure to reference the per-entity setting to turn on health alerts.
Related Name
Default Value
Bad
API Name
eventserver_health_events_alert_threshold
Required
false

Event Server Index Directory

Description
Location of the Lucene index for Event Server
Related Name
eventcatcher.server.lucenedir
Default Value
/var/lib/cloudera-scm-eventserver
API Name
eventserver_index_dir
Required
false

Maximum Number of Events in the Event Server Store

Description
The maximum size of the Event Server store, in events. Once this size is exceeded, events is deleted started with the oldest first until the size of the store returns below this threshold
Related Name
eventcatcher.event.capacity
Default Value
5000000
API Name
eventserver_max_index_size
Required
true

Starting Interval for Descriptor Fetch Attempts

Description
The starting interval between fetch attempts for the SCM descriptor when Cloudera Management Service roles are starting. The interval is increased by an additional one second with each failed fetch attempt.
Related Name
mgmt.descriptor.fetch.frequency
Default Value
2 second(s)
API Name
mgmt_descriptor_fetch_frequency
Required
true

Descriptor Fetch Max Attempts

Description
Maximum number of attempts to fetch the SCM descriptor when Cloudera Management Service roles are starting. If the roles are not able to get the descriptor in this number of attempts, then the roles exit.
Related Name
mgmt.num.descriptor.fetch.tries
Default Value
10
API Name
mgmt_num_descriptor_fetch_tries
Required
true

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

Event Server Web UI Port

Description
Port for the Event Server's Debug page. Set to -1 to disable debug server.
Related Name
eventcatcher.server.debug.port
Default Value
8084
API Name
eventserver_debug_port
Required
false

Event Query Port

Description
Port on which the Event Server listens for queries for events.
Related Name
eventcatcher.server.httpport
Default Value
7185
API Name
eventserver_http_port
Required
false

Event Publish Port

Description
Port on which the Event Server listens for the publication of events.
Related Name
eventcatcher.server.port
Default Value
7184
API Name
eventserver_listen_port
Required
false

Resource Management

Java Heap Size of EventServer in Bytes

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

Cgroup CPU Shares

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

Custom Control Group Resources (overrides Cgroup settings)

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

Cgroup I/O Weight

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

Cgroup Memory Hard Limit

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

Cgroup Memory Soft Limit

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

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: Event Server Web UI Port

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

Suppress Parameter Validation: Event Query Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Event Query Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_eventserver_http_port
Required
true

Suppress Parameter Validation: Event Server Index Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Event Server Index Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_eventserver_index_dir
Required
true

Suppress Parameter Validation: Java Configuration Options for Event Server

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

Suppress Parameter Validation: Event Publish Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Event Publish Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_eventserver_listen_port
Required
true

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

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

Suppress Parameter Validation: Event Server Advanced Configuration Snippet (Safety Valve) for eventserver.conf

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

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

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Event 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: Rules to Extract Events from Log Files

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Rules to Extract Events from Log Files parameter.
Related Name
Default Value
false
API Name
role_config_suppression_log_event_whitelist
Required
true

Suppress Parameter Validation: Event Server Log Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Event Server Log Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_mgmt_log_dir
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: 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_event_server_audit_health
Required
true

Suppress Health Test: Event Store Size

Description
Whether to suppress the results of the Event Store 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_event_server_event_store_size
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_event_server_file_descriptor
Required
true

Suppress Health Test: GC Duration

Description
Whether to suppress the results of the GC 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_event_server_gc_duration
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_event_server_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_event_server_host_health
Required
true

Suppress Health Test: Event Server Index Directory Free Space

Description
Whether to suppress the results of the Event Server Index 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_event_server_index_directory_free_space
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_event_server_log_directory_free_space
Required
true

Suppress Health Test: Cloudera Manager Descriptor Age

Description
Whether to suppress the results of the Cloudera Manager Descriptor Age 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_event_server_scm_descriptor_fetch
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_event_server_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_event_server_swap_memory_usage
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_event_server_unexpected_exits
Required
true

Suppress Health Test: Web Server Status

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

Suppress Health Test: Write Pipeline

Description
Whether to suppress the results of the Write Pipeline 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_event_server_write_pipeline
Required
true

Host Monitor

Advanced

Java Configuration Options for Host Monitor

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

Host Monitor Advanced Configuration Snippet (Safety Valve) for cmon.conf

Description
For advanced use only. A string to be inserted into cmon.conf for this role only.
Related Name
Default Value
API Name
firehose_safety_valve
Required
false

Host Monitor 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
HOSTMONITOR_role_env_safety_valve
Required
false

Host Monitor 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

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 heap dump file when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value
true
API Name
oom_heap_dump_enabled
Required
true

Kill When Out of Memory

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

Automatically Restart Process

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

Enable Metric Collection

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

Process Start Retry Attempts

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

Process Start Wait Timeout

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

Event Publication Maximum Queue Size

Description
The maximum size of the queue in which events published from this role will be buffered. If this queue becomes full (for example, due to an outage), subsequent events will be dropped.
Related Name
health.event.publish.queue.max
Default Value
20000
API Name
svcmon_event_publication_queue_size_max
Required
true

Event Publication Retry Period

Description
If an event cannot be delivered immediately by this role, this value controls how long to wait before Event Publisher retries delivery.
Related Name
health.event.publish.retry.ms
Default Value
5000
API Name
svcmon_event_publication_retry_period
Required
true

Logs

Host Monitor Logging Threshold

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

Host Monitor Maximum Log File Backups

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

Host Monitor Max Log Size

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

Host Monitor Log Directory

Description
Location of log files for Host Monitor
Related Name
Default Value
/var/log/cloudera-scm-firehose
API Name
mgmt_log_dir
Required
false

Monitoring

Metrics Aggregation Run Duration Thresholds

Description
The health test thresholds for monitoring the metrics aggregation run duration.
Related Name
Default Value
Warning: 10 second(s), Critical: 30 second(s)
API Name
aggregation_run_duration_thresholds
Required
false

Enable Health Alerts for this Role

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

Enable Configuration Change Alerts

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

Host Monitor Storage Directory Free Space Monitoring Absolute Thresholds

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

Host Monitor Storage Directory Free Space Monitoring Percentage Thresholds

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

Host Monitor Host Health Test

Description
When computing the overall Host Monitor health, consider the host's health.
Related Name
Default Value
true
API Name
hostmonitor_host_health_enabled
Required
false

Host Monitor Host Pipeline Monitoring Thresholds

Description
The health test thresholds for monitoring the Host Monitor host pipeline. This specifies the number of dropped messages that will be tolerated over the monitoring time period.
Related Name
Default Value
Warning: Never, Critical: Any
API Name
hostmonitor_host_pipeline_thresholds
Required
false

Host Monitor Host Pipeline Monitoring Time Period

Description
The time period over which the Host Monitor host pipeline will be monitored for dropped messages.
Related Name
Default Value
5 minute(s)
API Name
hostmonitor_host_pipeline_window
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
hostmonitor_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
hostmonitor_pause_duration_window
Required
false

Host Monitor Process Health Test

Description
Enables the health test that the Host Monitor's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
hostmonitor_scm_health_enabled
Required
false

Web Metric Collection

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

Web Metric Collection Duration

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

Log Directory Free Space Monitoring Absolute Thresholds

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

Log Directory Free Space Monitoring Percentage Thresholds

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

Rules to Extract Events from Log Files

Description
This file contains the rules that govern how log messages are turned into events by the custom log4j appender that this role loads. It is in JSON format, and is composed of a list of rules. Every log message is evaluated against each of these rules in turn to decide whether or not to send an event for that message. If a log message matches multiple rules, the first matching rule is used.. Each rule has some or all of the following fields:
  • alert - whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".
  • rate (mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more than rate matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.
  • periodminutes - the number of minutes during which the publisher will only publish rate events or fewer. If not specified, the default is one minute
  • threshold - apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.
  • content - match only those messages for which contents match this regular expression.
  • exceptiontype - match only those messages that are part of an exception message. The exception type must match this regular expression.
Example:
  • {"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}This rule sends events to Cloudera Manager for every StringIndexOutOfBoundsException, up to a maximum of 10 every minute.
  • {"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.
Related Name
Default Value
version: 0, rules: [ alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Instead, use .* , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Use .* instead , alert: false, rate: 1, periodminutes: 1, threshold: FATAL , alert: false, rate: 1, periodminutes: 2, exceptiontype: .* , alert: false, rate: 1, periodminutes: 1, threshold: WARN ]
API Name
log_event_whitelist
Required
false

Cloudera Manager Metric Schema Age Thresholds

Description
The health test thresholds for monitoring the time since the Cloudera Manager metric schema was last refreshed.
Related Name
Default Value
Warning: 60000.0, Critical: 120000.0
API Name
metric_schema_age_thresholds_name
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

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

Cloudera Manager Descriptor Age Thresholds

Description
The health test thresholds for monitoring the time since the Cloudera Manager descriptor was last refreshed.
Related Name
Default Value
Warning: 60000.0, Critical: 120000.0
API Name
scm_descriptor_age_thresholds
Required
false

Unexpected Exits Thresholds

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

Unexpected Exits Monitoring Period

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

Other

Use the Authentication Service to enable Single Sign On

Description
Use the Authentication Service to enable Single Sign On for the Firehose debug servers. Requires a running Authentication Service.
Related Name
debug.servlet.auth.enabled
Default Value
false
API Name
debug_servlet_auth_enabled
Required
false

Host Monitor Storage Directory

Description
The directory where Host Monitor data is stored. The Host Monitor stores metric time series and health information.
Related Name
firehose.storage.base.directory
Default Value
/var/lib/cloudera-host-monitor
API Name
firehose_storage_dir
Required
true

Time-Series Storage

Description
The approximate amount of disk space dedicated to storing time series and health data. Once the store has reached its maximum size, older data is deleted to make room for newer data. The disk usage is approximate because data is deleted only when the limit is reached.Note that Cloudera Manager stores time-series data at a number of different data granularities, and these granularities have different effective retention periods. Specifically, Cloudera Manager stores metric data as both raw data points and ten-minutely, hourly, six-hourly, daily, and weekly summary data points. Raw data consumes the bulk of the allocated storage space, weekly summaries the least. As such, raw data is retained for the shortest amount of time, while weekly summary points are unlikely to ever be deleted.See the "Storage" tab on the 'Host Monitor' -> 'Charts Library' -> 'Host Monitor Storage' page for more information on how space is consumed within the Host Monitor. This tab also shows information about the amount of data retained and time window covered by each data granularity.
Related Name
firehose_time_series_storage_bytes
Default Value
10 GiB
API Name
firehose_time_series_storage_bytes
Required
false

Health Event Startup Policy

Description
This setting controls whether health events are emitted when this monitoring role is started. If set to "none", then no health events are emitted. If set to "bad" then health events are emitted for subjects with bad or concerning health. If set to "all" then health events are emitted for all subjects for all health values. The default is "bad".
Related Name
health.event.publish.startup.policy
Default Value
bad
API Name
health_event_publish_startup_policy
Required
false

Starting Interval for Descriptor Fetch Attempts

Description
The starting interval between fetch attempts for the SCM descriptor when Cloudera Management Service roles are starting. The interval is increased by an additional one second with each failed fetch attempt.
Related Name
mgmt.descriptor.fetch.frequency
Default Value
2 second(s)
API Name
mgmt_descriptor_fetch_frequency
Required
true

Descriptor Fetch Max Attempts

Description
Maximum number of attempts to fetch the SCM descriptor when Cloudera Management Service roles are starting. If the roles are not able to get the descriptor in this number of attempts, then the roles exit.
Related Name
mgmt.num.descriptor.fetch.tries
Default Value
10
API Name
mgmt_num_descriptor_fetch_tries
Required
true

Event Publication Log Quiet Time Period

Description
To avoid producing excessive amounts of log output, the Event Publisher component of this role is limited to emitting one message per time period. This value controls the size of that time period.
Related Name
health.event.publish.log.suppress.window.ms
Default Value
1 minute(s)
API Name
svcmon_event_publication_log_suppress_window
Required
true

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

Host Monitor Web UI Port

Description
Port for Host Monitor's Debug page. Set to -1 to disable the debug server.
Related Name
debug.servlet.port
Default Value
8091
API Name
firehose_debug_port
Required
false

Host Monitor Web UI HTTPS Port

Description
Port for Host Monitor's HTTPS Debug page.
Related Name
debug.servlet.https.port
Default Value
9091
API Name
firehose_debug_tls_port
Required
false

Host Monitor Listen Port

Description
Port where Host Monitor is listening for agent messages.
Related Name
firehose.server.port
Default Value
9995
API Name
firehose_listen_port
Required
false

Host Monitor Nozzle Port

Description
Port where Host Monitor's query API is exposed.
Related Name
nozzle.server.port
Default Value
9994
API Name
firehose_nozzle_port
Required
false

Bind Host Monitor to Wildcard Address

Description
If enabled, the Host Monitor binds to the wildcard address ("0.0.0.0") on all of its ports.
Related Name
Default Value
false
API Name
hmon_bind_wildcard
Required
false

Resource Management

Java Heap Size of Host Monitor in Bytes

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

Maximum Non-Java Memory of Host Monitor

Description
The amount of memory the Host Monitor can use off of the Java heap.
Related Name
firehose_non_java_memory_bytes
Default Value
2 GiB
API Name
firehose_non_java_memory_bytes
Required
false

Cgroup CPU Shares

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

Custom Control Group Resources (overrides Cgroup settings)

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

Cgroup I/O Weight

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

Cgroup Memory Hard Limit

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

Cgroup Memory Soft Limit

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

Security

Enable TLS/SSL for Firehose Debug Server

Description
Encrypt communication between clients and Firehose Debug Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name
debug.servlet.https.enabled
Default Value
false
API Name
ssl_enabled
Required
false

Firehose Debug Server 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 Firehose Debug Server is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name
debug.servlet.https.keystorePath
Default Value
API Name
ssl_server_keystore_location
Required
false

Firehose Debug Server TLS/SSL Server Keystore File Password

Description
The password for the Firehose Debug Server keystore file.
Related Name
debug.servlet.https.keystorePassword
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: Host Monitor Web UI Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Host Monitor Web UI Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_debug_port
Required
true

Suppress Parameter Validation: Host Monitor Web UI HTTPS Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Host Monitor Web UI HTTPS Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_debug_tls_port
Required
true

Suppress Configuration Validator: Host Monitor Heap Size Validator

Description
Whether to suppress configuration warnings produced by the Host Monitor Heap Size Validator configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_host_monitor_heap_role_validator
Required
true

Suppress Configuration Validator: Host Monitor Off Heap Memory Size Validator

Description
Whether to suppress configuration warnings produced by the Host Monitor Off Heap Memory Size Validator configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_host_monitor_non_java_memory_role_validator
Required
true

Suppress Parameter Validation: Java Configuration Options for Host Monitor

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

Suppress Parameter Validation: Host Monitor Listen Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Host Monitor Listen Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_listen_port
Required
true

Suppress Parameter Validation: Host Monitor Nozzle Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Host Monitor Nozzle Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_nozzle_port
Required
true

Suppress Parameter Validation: Host Monitor Advanced Configuration Snippet (Safety Valve) for cmon.conf

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Host Monitor Advanced Configuration Snippet (Safety Valve) for cmon.conf parameter.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_safety_valve
Required
true

Suppress Parameter Validation: Host Monitor Storage Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Host Monitor Storage Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_firehose_storage_dir
Required
true

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

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

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

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Host Monitor 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: Rules to Extract Events from Log Files

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Rules to Extract Events from Log Files parameter.
Related Name
Default Value
false
API Name
role_config_suppression_log_event_whitelist
Required
true

Suppress Parameter Validation: Host Monitor Log Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Host Monitor Log Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_mgmt_log_dir
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: 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: Firehose Debug Server TLS/SSL Server Keystore File Location

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

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Firehose Debug Server 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: Metrics Aggregation Run Duration Test

Description
Whether to suppress the results of the Metrics Aggregation Run Duration 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_host_monitor_aggregation_run_duration
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_host_monitor_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_host_monitor_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_host_monitor_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_host_monitor_host_health
Required
true

Suppress Health Test: Host Pipeline

Description
Whether to suppress the results of the Host Pipeline 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_host_monitor_host_pipeline
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_host_monitor_log_directory_free_space
Required
true

Suppress Health Test: Cloudera Manager Metric Schema Age

Description
Whether to suppress the results of the Cloudera Manager Metric Schema Age 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_host_monitor_metric_schema_fetch
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_host_monitor_pause_duration
Required
true

Suppress Health Test: Cloudera Manager Descriptor Age

Description
Whether to suppress the results of the Cloudera Manager Descriptor Age 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_host_monitor_scm_descriptor_fetch
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_host_monitor_scm_health
Required
true

Suppress Health Test: Host Monitor Storage Directory Free Space

Description
Whether to suppress the results of the Host Monitor Storage 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_host_monitor_storage_directory_free_space
Required
true

Suppress Health Test: Swap Memory Usage

Description
Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_host_monitor_swap_memory_usage
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_host_monitor_unexpected_exits
Required
true

Suppress Health Test: Web Server Status

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

Navigator Audit Server

Advanced

Navigator Audit 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

Navigator Audit Server Advanced Configuration Snippet (Safety Valve) for db.navigator.properties

Description
For advanced use only. A string to be inserted into db.navigator.properties for this role only.
Related Name
Default Value
API Name
navigator_db_safety_valve
Required
false

Java Configuration Options for Navigator Audit

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

Navigator Audit 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
NAVIGATOR_role_env_safety_valve
Required
false

Navigator Audit Server Advanced Configuration Snippet (Safety Valve) for cloudera-navigator.properties

Description
For advanced use only. A string to be inserted into cloudera-navigator.properties for this role only.
Related Name
Default Value
API Name
navigator_server_safety_valve
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 heap dump file when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value
true
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

PII Masking Regular Expression

Description
Regular expression that identifies the strings to be masked. Changing this expression does not mask the strings in previous entries. Leave blank to bypass masking. This feature is superseded by cluster-wide redaction of logs and SQL queries, as an HDFS service-wide configuration parameter.
Related Name
navigator.pii.masking.regex
Default Value
(4[0-9]12(?:[0-9]3)?)|(5[1-5][0-9]14)|(3[47][0-9]13)|(3(?:0[0-5]|[68][0-9])[0-9]11)|(6(?:011|5[0-9]2)[0-9]12)|((?:2131|1800|35\d3)\d11)
API Name
pii_masking_regex
Required
false

Automatically Restart Process

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

Enable Metric Collection

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

Process Start Retry Attempts

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

Process Start Wait Timeout

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

Database

Navigator Audit Server Database Hostname

Description
Name of the host where Navigator Audit Server's database is running. It is highly recommended that this database is on the same host as Navigator Audit Server. If the database is not running on its default port, specify the port number using this syntax: 'host:port'
Related Name
navigator.db.host
Default Value
localhost
API Name
navigator_database_host
Required
false

Navigator Audit Server Database Name

Description
The name of the Navigator Audit Server's database.
Related Name
navigator.db.name
Default Value
nav
API Name
navigator_database_name
Required
true

Navigator Audit Server Database Password

Description
The password for Navigator Audit Server's database user account.
Related Name
navigator.db.password
Default Value
API Name
navigator_database_password
Required
false

Navigator Audit Server Database Type

Description
Type of database used for Navigator Audit Server.
Related Name
navigator.db.type
Default Value
mysql
API Name
navigator_database_type
Required
false

Navigator Audit Server Database Username

Description
The username to use to log into Navigator Audit Server's database.
Related Name
navigator.db.user
Default Value
nav
API Name
navigator_database_user
Required
true

Logs

Navigator Audit Server Logging Threshold

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

Navigator Audit Server Maximum Log File Backups

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

Navigator Audit Server Max Log Size

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

Navigator Audit Server Log Directory

Description
Directory where Navigator Audit Server will place its log files.
Related Name
Default Value
/var/log/cloudera-scm-navigator
API Name
mgmt_log_dir
Required
false

Monitoring

Enable Health Alerts for this Role

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

Enable Configuration Change Alerts

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

Heap Dump Directory Free Space Monitoring Absolute Thresholds

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

Heap Dump Directory Free Space Monitoring Percentage Thresholds

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

Log Directory Free Space Monitoring Absolute Thresholds

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

Log Directory Free Space Monitoring Percentage Thresholds

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

Rules to Extract Events from Log Files

Description
This file contains the rules that govern how log messages are turned into events by the custom log4j appender that this role loads. It is in JSON format, and is composed of a list of rules. Every log message is evaluated against each of these rules in turn to decide whether or not to send an event for that message. If a log message matches multiple rules, the first matching rule is used.. Each rule has some or all of the following fields:
  • alert - whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".
  • rate (mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more than rate matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.
  • periodminutes - the number of minutes during which the publisher will only publish rate events or fewer. If not specified, the default is one minute
  • threshold - apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.
  • content - match only those messages for which contents match this regular expression.
  • exceptiontype - match only those messages that are part of an exception message. The exception type must match this regular expression.
Example:
  • {"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}This rule sends events to Cloudera Manager for every StringIndexOutOfBoundsException, up to a maximum of 10 every minute.
  • {"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.
Related Name
Default Value
version: 0, rules: [ alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Instead, use .* , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Use .* instead , alert: false, rate: 1, periodminutes: 1, threshold: FATAL , alert: false, rate: 1, periodminutes: 2, exceptiontype: .* , alert: false, rate: 1, periodminutes: 1, threshold: WARN ]
API Name
log_event_whitelist
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

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
navigator_fd_thresholds
Required
false

Garbage Collection Duration Thresholds

Description
The health test thresholds for the weighted average time spent in Java garbage collection. Specified as a percentage of elapsed wall clock time.
Related Name
Default Value
Warning: 30.0, Critical: 60.0
API Name
navigator_gc_duration_thresholds
Required
false

Garbage Collection Duration Monitoring Period

Description
The period to review when computing the moving average of garbage collection time.
Related Name
Default Value
5 minute(s)
API Name
navigator_gc_duration_window
Required
false

Navigator Audit Server Host Health Test

Description
When computing the overall Navigator Audit Server health, consider the host's health.
Related Name
Default Value
true
API Name
navigator_host_health_enabled
Required
false

Navigator Audit Server Process Health Test

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

Web Metric Collection

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

Web Metric Collection Duration

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

Process Swap Memory Thresholds

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

Role Triggers

Description
The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
Related Name
Default Value
[]
API Name
role_triggers
Required
true

Unexpected Exits Thresholds

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

Unexpected Exits Monitoring Period

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

Other

Navigator Audit Server Data Expiration Period

Description
The number of hours of past audit events to keep in the Navigator Audit Server database. This will affect the size of the database.
Related Name
navigator.db.hours.retained
Default Value
90 day(s)
API Name
hours_retained
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

Navigator Audit Server Web UI Port

Description
The port where Navigator Audit Server starts a debug web server. Set to -1 to disable debug server.
Related Name
navigator.server.debug.port
Default Value
8089
API Name
navigator_debug_port
Required
false

Navigator Audit Server Port

Description
The port where Navigator Audit Server listens for requests
Related Name
navigator.server.port
Default Value
7186
API Name
navigator_server_port
Required
false

Publishing

Kafka Topic

Description
The name of the Kafka topic where Navigator will publish audit events.
Related Name
Default Value
NavigatorAuditEvents
API Name
navigator_kafka_publishing_topic
Required
false

Resource Management

Java Heap Size of Auditing Server in Bytes

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

Cgroup CPU Shares

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

Custom Control Group Resources (overrides Cgroup settings)

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

Cgroup I/O Weight

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

Cgroup Memory Hard Limit

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

Cgroup Memory Soft Limit

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

Security

Navigator Kerberos Principal

Description
Kerberos principal used by Navigator to authenticate to all services except HDFS. Note: Navigator should use the principal used by Hue service if you are using MapReduce1 service in any cluster.
Related Name
Default Value
hue
API Name
kerberos_role_princ_name
Required
true

Navigator 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 Navigator 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
navigator_truststore_file
Required
false

Navigator TLS/SSL Trust Store Password

Description
The password for the Navigator 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
navigator_truststore_password
Required
false

Enable TLS/SSL for NAVIGATOR

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

TLS/SSL Keystore Key Password

Description
The password that protects the private key contained in the keystore used when NAVIGATOR is acting as a TLS/SSL server.
Related Name
nav.ssl.keyManagerPassword
Default Value
API Name
ssl_server_keystore_keypassword
Required
false

TLS/SSL 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 NAVIGATOR is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name
nav.ssl.keyStorePath
Default Value
API Name
ssl_server_keystore_location
Required
false

TLS/SSL Keystore File Password

Description
The password for the NAVIGATOR keystore file.
Related Name
nav.ssl.keyStorePassword
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: Navigator Kerberos Principal

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

Suppress Parameter Validation: Navigator Audit Server Logging Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Audit 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: Rules to Extract Events from Log Files

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Rules to Extract Events from Log Files parameter.
Related Name
Default Value
false
API Name
role_config_suppression_log_event_whitelist
Required
true

Suppress Parameter Validation: Navigator Audit Server Log Directory

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

Suppress Parameter Validation: Navigator Audit Server Database Hostname

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Audit Server Database Hostname parameter.
Related Name
Default Value
false
API Name
role_config_suppression_navigator_database_host
Required
true

Suppress Parameter Validation: Navigator Audit Server Database Name

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Audit Server Database Name parameter.
Related Name
Default Value
false
API Name
role_config_suppression_navigator_database_name
Required
true

Suppress Parameter Validation: Navigator Audit Server Database Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Audit Server Database Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_navigator_database_password
Required
true

Suppress Parameter Validation: Navigator Audit Server Database Username

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Audit Server Database Username parameter.
Related Name
Default Value
false
API Name
role_config_suppression_navigator_database_user
Required
true

Suppress Parameter Validation: Navigator Audit Server Advanced Configuration Snippet (Safety Valve) for db.navigator.properties

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Audit Server Advanced Configuration Snippet (Safety Valve) for db.navigator.properties parameter.
Related Name
Default Value
false
API Name
role_config_suppression_navigator_db_safety_valve
Required
true

Suppress Parameter Validation: Navigator Audit Server Web UI Port

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

Suppress Parameter Validation: Java Configuration Options for Navigator Audit

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

Suppress Parameter Validation: Kafka Topic

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Kafka Topic parameter.
Related Name
Default Value
false
API Name
role_config_suppression_navigator_kafka_publishing_topic
Required
true

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

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

Suppress Parameter Validation: Navigator Audit Server Port

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

Suppress Parameter Validation: Navigator Audit Server Advanced Configuration Snippet (Safety Valve) for cloudera-navigator.properties

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Audit Server Advanced Configuration Snippet (Safety Valve) for cloudera-navigator.properties parameter.
Related Name
Default Value
false
API Name
role_config_suppression_navigator_server_safety_valve
Required
true

Suppress Parameter Validation: Navigator TLS/SSL Trust Store File

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

Suppress Parameter Validation: Navigator TLS/SSL Trust Store Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator TLS/SSL Trust Store Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_navigator_truststore_password
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: PII Masking Regular Expression

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the PII Masking Regular Expression parameter.
Related Name
Default Value
false
API Name
role_config_suppression_pii_masking_regex
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: TLS/SSL Keystore Key Password

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

Suppress Parameter Validation: TLS/SSL Keystore File Location

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

Suppress Parameter Validation: TLS/SSL Keystore File Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the TLS/SSL 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_navigator_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_navigator_file_descriptor
Required
true

Suppress Health Test: GC Duration

Description
Whether to suppress the results of the GC 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_navigator_gc_duration
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_navigator_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_navigator_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_navigator_log_directory_free_space
Required
true

Suppress Health Test: Process Status

Description
Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_navigator_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_navigator_swap_memory_usage
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_navigator_unexpected_exits
Required
true

Suppress Health Test: Web Server Status

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

Navigator Metadata Server

Advanced

Allow Usage Data Collection

Description
Allows Cloudera to collect usage data, including the use of Google Analytics.
Related Name
nav.allow_usage_data
Default Value
true
API Name
allow_usage_data
Required
true

Navigator Metadata 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

Navigator Metadata Server Install Dir

Description
The directory where Navigator Metadata Server is installed. This allows overriding the version packaged with the Cloudera Manager Server.
Related Name
Default Value
API Name
nav_install_dir
Required
false

Navigator Metadata Server 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

Java Configuration Options for Navigator Metadata Server

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

Navigator Metadata Server Advanced Configuration Snippet (Safety Valve) for cloudera-navigator.properties

Description
For advanced use only. A string to be inserted into cloudera-navigator.properties for this role only.
Related Name
Default Value
API Name
navigator_safety_valve
Required
false

Navigator Metadata 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
NAVIGATORMETASERVER_role_env_safety_valve
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 heap dump file when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value
true
API Name
oom_heap_dump_enabled
Required
true

Kill When Out of Memory

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

Automatically Restart Process

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

Enable Metric Collection

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

Process Start Retry Attempts

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

Process Start Wait Timeout

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

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 NAVMS events:
  • operation: Navigator operation performed e.g. auditReport, savedSearch etc.
  • username: the user performing the action.
  • ipAddress: the IP from where the request originated.
  • allowed: whether the operation was allowed or denied.
Related Name
navigator.event.filter
Default Value
API Name
navigator_audit_event_filter
Required
false

Database

Navigator Metadata Server Database Hostname

Description
Name of the host where the Navigator Metaserver database is running. If the database is not running on its default port, specify the port number using this syntax: 'host:port'.
Related Name
navms.db.host
Default Value
localhost
API Name
nav_metaserver_database_host
Required
false

Navigator Metadata Server Database Name

Description
The name of the Navigator Metadata Server database.
Related Name
navms.db.name
Default Value
navms
API Name
nav_metaserver_database_name
Required
true

Navigator Metadata Server Database Password

Description
The password for Navigator Metadata Server database user account.
Related Name
navms.db.password
Default Value
API Name
nav_metaserver_database_password
Required
false

Navigator Metadata Server Database Type

Description
Type of database used for Navigator Metadata Server.
Related Name
navms.db.type
Default Value
mysql
API Name
nav_metaserver_database_type
Required
false

Navigator Metadata Server Database Username

Description
The username to use to log into the Navigator Metadata Server database.
Related Name
navms.db.user
Default Value
navms
API Name
nav_metaserver_database_user
Required
true

External Authentication

Authentication Backend Order

Description
The order in which authentication backends are used for authenticating a user. For Cloudera Manager authentication, only users with role 'Full Administrator' and 'Navigator Administrator' are allowed. In addition, users authenticated by Cloudera Manager using external authentication mechanism are not allowed. Navigator will authenticate external users itself and will not rely on Cloudera Manager.
Related Name
nav.auth.backend.order
Default Value
CM_ONLY
API Name
auth_backend_order
Required
true

External Authentication Type

Description
The type of external authentication system to use.
Related Name
nav.external.auth.type
Default Value
LDAP
API Name
external_auth_type
Required
true

Cloudera Navigator S3 Lineage AWS Credentials

Description
Enable Cloudera Navigator to extract metadata and lineage for data that is written to S3 buckets in this account.
Related Name
Default Value
API Name
nav_extraction_external_account
Required
false

LDAP Bind User Distinguished Name

Description
Distinguished name of the user to bind to AD as for user authentication search/bind and group lookup for role authorization. For openLDAP based directories this should be a DN string, for Active Directory this can be just a username, combined with the "Active Directory Domain" value for login. For example username in the field and example.com in the active directory domain will result in the User Principal Name value of username@example.com being used to bind. If you put a UPM value here, do not over-configure the "active directory domain" field otherwise you will end up presenting username@example.com@example.com for binds. AD will accept a UPN value or the DN value as a valid Bind DN; An example of a Distinguished Name (DN): CN=cdh admin,OU=svcaccount,DC=example,DC=com An example of a UPN value: cdhadmin@example.com
Related Name
nav.ldap.bind.dn
Default Value
API Name
nav_ldap_bind_dn
Required
false

LDAP Bind Password

Description
The password of the bind user.
Related Name
nav.ldap.bind.pw
Default Value
API Name
nav_ldap_bind_pw
Required
false

LDAP Distinguished Name Pattern

Description
This setting is deprecated and soon to be removed, do not use LDAP Distinguished Name Pattern for configuration moving forward. It is not necessary to use and deprecated as a configuration approach for LDAP and AD in general.
Related Name
nav.ldap.dn.pattern
Default Value
API Name
nav_ldap_dn_pattern
Required
false

LDAP Group Search Base

Description
The distinguished name indicating the path within the directory information tree to begin group searches from. For example in AD it would be cn=groups,dc=example,dc=com. Or in an openLDAP compatible situation it would be something like ou=groups,dc=example,dc=com. Check with your directory administration team on the proper search base to configure for your environment.
Related Name
nav.ldap.group.search.base
Default Value
API Name
nav_ldap_group_search_base
Required
false

LDAP Group Search Filter For Logged In User

Description
A search filter for finding groups that the logged-in user belongs to. Typically, this is (member={0}), where {0} is replaced by the DN of a successfully authenticated user.
Related Name
nav.ldap.group.search.filter
Default Value
API Name
nav_ldap_group_search_filter
Required
false

LDAP Groups Search Filter

Description
The search filter to use for finding groups for authorization of authenticated users for their cloudera manager role. For Active Directory and openLDAP compatible directories this will usually be (member={0}), where {0} will be replaced by DN string for a successfully authenticated user through the search/bind process. This requires configuration of the LDAP Bind User Distinguished Name field.
Related Name
nav.ldap.groups.search.filter
Default Value
(&(objectClass=groupOfNames)(cn=*0*))
API Name
nav_ldap_groups_search_filter
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
nav.ldap.url
Default Value
API Name
nav_ldap_url
Required
false

LDAP User Search Base

Description
The distinguished name indicating the path within the directory information tree to begin user searches from. For example in AD it would be cn=users,dc=example,dc=com. Or in an openLDAP compatible situation it would be something like ou=people,dc=example,dc=com. Check with your directory administration team on the proper user search base to configure for your environment.
Related Name
nav.ldap.user.search.base
Default Value
API Name
nav_ldap_user_search_base
Required
false

LDAP User Search Filter

Description
The search filter to use for finding users. For AD configuration it will be (sAMAccountName={0}) and for openLDAP compatible directories it will usually be (uid={0}). Note that a custom attribute can also be used if the directory is configured differently for user names. The {0} expands the currently authenticating user''s name entered in the login form for the query.
Related Name
nav.ldap.user.search.filter
Default Value
API Name
nav_ldap_user_search_filter
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
nav.nt_domain
Default Value
API Name
nav_nt_domain
Required
false

SAML Entity Base URL

Description
The Base URL used to construct redirect URLs reported in this server's SP metadata. Leave this blank to let the server calculate the base URL.
Related Name
nav.saml.entity.base_url
Default Value
API Name
nav_saml_entity_base_url
Required
false

SAML Entity ID

Description
The ID that Navigator Metadata Server uses to identify itself to the IDP. This value should be unique to this Navigator Metadata Server installation.
Related Name
nav.saml.entity.id
Default Value
clouderaNavigator
API Name
nav_saml_entity_id
Required
true

Alias of SAML Sign/Encrypt Private Key

Description
The alias used to identify the sign/encrypt private key in the SAML keystore.
Related Name
nav.saml.key.alias
Default Value
API Name
nav_saml_key_alias
Required
false

SAML Sign/Encrypt Private Key Password

Description
The password for the sign/encrypt private key in the SAML keystore.
Related Name
nav.saml.key.password
Default Value
API Name
nav_saml_key_password
Required
false

SAML Keystore Password

Description
The password for the SAML keystore.
Related Name
nav.saml.keystore.password
Default Value
API Name
nav_saml_keystore_password
Required
false

Path to SAML Keystore File

Description
The filesystem path to the keystore file containing the SP private key and any necessary public certificates to validate the IDP.
Related Name
nav.saml.keystore.path
Default Value
API Name
nav_saml_keystore_path
Required
false

SAML Login URL

Description
If your IDP does not support SP-initiated SSO (very uncommon), you use a separate login URL, outside of Navigator Metadata Server. Provide that URL here so that Navigator Metadata Server can use it when a user needs to log in.
Related Name
nav.saml.login.url
Default Value
API Name
nav_saml_login_url
Required
false

Path to SAML IDP Metadata File

Description
The filesystem path to the IDP metadata XML file.
Related Name
nav.saml.metadata.path
Default Value
API Name
nav_saml_metadata_path
Required
false

SAML Attribute Identifier for User Role

Description
The URN OID that identifies the user role in the SAML attributes. Only has an effect when 'Attribute'-based role assignment is used.
Related Name
nav.saml.oid.role
Default Value
urn:oid:2.5.4.11
API Name
nav_saml_oid_role
Required
true

SAML Attribute Identifier for User ID

Description
The URN OID that identifies the user ID in the SAML attributes.
Related Name
nav.saml.oid.user
Default Value
urn:oid:0.9.2342.19200300.100.1.1
API Name
nav_saml_oid_user
Required
true

SAML Response Binding

Description
The SAML binding format that the IDP is asked to use when sending authentication responses.
Related Name
nav.saml.response.binding
Default Value
ARTIFACT
API Name
nav_saml_response_binding
Required
true

SAML Attribute Values for Roles

Description
The values that appear in the SAML role attribute for each Navigator Metadata Server role. The first value corresponds to the Full Administrator role. The second value corresponds to the User Administrator role. The third value corresponds to the Auditing Viewer role. The fourth value corresponds to the Lineage Viewer role. The fifth value corresponds to the Metadata Administrator role. The sixth value corresponds to the Policy Viewer role. The seventh value corresponds to the Policy Administartor role. To assign more than one role, the attribute can return values separated by a comma, like "role1, role2".
Related Name
nav.saml.role.map
Default Value
admin useradmin auditingviewer lineageviewer metadataadmin policyviewer policyadmin
API Name
nav_saml_role_map
Required
true

SAML Role Assignment Mechanism

Description
The mechanism to use for assigning roles to users. 'Attribute' assigns roles based on a SAML attribute. 'Script' assigns roles based on the result of an external script.
Related Name
nav.saml.role.mapper
Default Value
ATTRIBUTE
API Name
nav_saml_role_mapper
Required
true

Path to SAML Role Assignment Script

Description
An external script (or binary) to use to assign roles to SAML users. The username is passed as the first command-line argument. You can configure the return codes for the external script on the Roles page. A negative return value indicates a failure.
Related Name
nav.saml.role.script
Default Value
API Name
nav_saml_role_script
Required
false

Source of User ID in SAML Response

Description
Whether the user ID should be obtained from the SAML response NameID field or from an attribute
Related Name
nav.saml.user.source
Default Value
ATTRIBUTE
API Name
nav_saml_user_source
Required
true

Cloudera Telemetry Publisher S3 Bucket

Description
The name of the S3 bucket where Cloudera Telemetry Publisher from remote clusters will upload metadata to for Cloudera Navigator.
Related Name
nav_telemetry_bucket_name
Default Value
API Name
nav_telemetry_bucket_name
Required
false

Cloudera Telemetry Publisher AWS Credentials

Description
Enable Cloudera Navigator to extract metadata and lineage from other clusters (e.g., Cloudera Altus) collected via Cloudera Telemetry Publisher.
Related Name
Default Value
API Name
nav_telemetry_external_account
Required
false

Extractor Filter

HDFS Filter Enable

Description
Enable HDFS Filtering. When Enabled, filters out the extraction of the items in the blacklist
Related Name
nav.filter.hdfs.enable
Default Value
false
API Name
nav_filter_hdfs_enable
Required
false

HDFS Filter Blacklist

Description
List of paths to be filtered out. The paths can be regular expressions.
Related Name
nav.filter.hdfs.blacklist
Default Value
API Name
nav_filter_hdfs_rules
Required
false

S3 Filter Default Action

Description
Set to Accept to extract all S3 buckets except for the ones blacklisted. Set to Discard to extract only the buckets that are whitelisted.
Related Name
nav.filter.s3.default.action
Default Value
ACCEPT
API Name
nav_filter_s3_default_action
Required
false

S3 Filter Enable

Description
Enable S3 Filtering
Related Name
nav.filter.s3.enable
Default Value
false
API Name
nav_filter_s3_enable
Required
false

S3 Filter list

Description
List of S3 buckets to be whitelisted or blacklisted. The strings can be regular extressions.
Related Name
nav.filter.s3.list
Default Value
API Name
nav_filter_s3_rules
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/cloudera-scm-navigator/audit
API Name
audit_event_log_dir
Required
false

Navigator Metadata Server Logging Threshold

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

Navigator Metadata Server Maximum Log File Backups

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

Navigator Metadata Server Max Log Size

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

Navigator Metadata Server Log Directory

Description
Directory where Navigator Metadata Server will place its log files.
Related Name
Default Value
/var/log/cloudera-scm-navigator
API Name
mgmt_log_dir
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

Monitoring

Enable Health Alerts for this Role

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

Enable Configuration Change Alerts

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

Heap Dump Directory Free Space Monitoring Absolute Thresholds

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

Heap Dump Directory Free Space Monitoring Percentage Thresholds

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

Log Directory Free Space Monitoring Absolute Thresholds

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

Log Directory Free Space Monitoring Percentage Thresholds

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

Rules to Extract Events from Log Files

Description
This file contains the rules that govern how log messages are turned into events by the custom log4j appender that this role loads. It is in JSON format, and is composed of a list of rules. Every log message is evaluated against each of these rules in turn to decide whether or not to send an event for that message. If a log message matches multiple rules, the first matching rule is used.. Each rule has some or all of the following fields:
  • alert - whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".
  • rate (mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more than rate matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.
  • periodminutes - the number of minutes during which the publisher will only publish rate events or fewer. If not specified, the default is one minute
  • threshold - apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.
  • content - match only those messages for which contents match this regular expression.
  • exceptiontype - match only those messages that are part of an exception message. The exception type must match this regular expression.
Example:
  • {"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}This rule sends events to Cloudera Manager for every StringIndexOutOfBoundsException, up to a maximum of 10 every minute.
  • {"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.
Related Name
Default Value
version: 0, rules: [ alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Instead, use .* , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Use .* instead , alert: false, rate: 1, periodminutes: 1, threshold: FATAL , alert: false, rate: 1, periodminutes: 2, exceptiontype: .* , alert: false, rate: 1, periodminutes: 1, threshold: WARN ]
API Name
log_event_whitelist
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

Audit 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 Audit Log Directory.
Related Name
Default Value
Warning: 10 GiB, Critical: 5 GiB
API Name
navigatormetaserver_audit_event_log_directory_free_space_absolute_thresholds
Required
false

Audit 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 Audit Log Directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Audit Log Directory Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
navigatormetaserver_audit_event_log_directory_free_space_percentage_thresholds
Required
false

Navigator Metadata Server Storage Dir Free Space Monitoring Absolute Thresholds

Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's Navigator Metadata Server Storage Dir.
Related Name
Default Value
Warning: 10 GiB, Critical: 5 GiB
API Name
navigatormetaserver_data_directory_free_space_absolute_thresholds
Required
false

Navigator Metadata Server Storage Dir Free Space Monitoring Percentage Thresholds

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

Navigator Metadata Server Host Health Test

Description
When computing the overall Navigator Metadata Server health, consider the host's health.
Related Name
Default Value
true
API Name
navigatormetaserver_host_health_enabled
Required
false

Navigator Metadata Server Process Health Test

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

Solr Element Count Threshold

Description
Threshold for throwing alert when the Solr Element Count reaches
Related Name
Default Value
Warning: 5.0E8, Critical: 1.0E9
API Name
navigatormetaserver_solr_element_count_threshold
Required
false

Solr Relation Count Threshold

Description
Threshold for throwing alert when the Solr Relation Count reaches
Related Name
Default Value
Warning: 5.0E8, Critical: 1.0E9
API Name
navigatormetaserver_solr_relation_count_threshold
Required
false

Process Swap Memory Thresholds

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

Role Triggers

Description
The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
Related Name
Default Value
[]
API Name
role_triggers
Required
true

Unexpected Exits Thresholds

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

Unexpected Exits Monitoring Period

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

Other

Navigator Metadata Server Storage Dir

Description
The directory where Navigator Metadata Server data is stored. Note that changing this location does not migrate existing data.
Related Name
nav.data.dir
Default Value
/var/lib/cloudera-scm-navigator
API Name
data_dir
Required
false

Default Facets

Description
List of metadata properties used by default for Navigator search facets. If no facets are listed, the facets used are some system properties such as "sourceType", "type", "owner", "clusterTemplate", "tags", “deleted”. Your entries here replace these system facets. For example, to include some of the system properties and a managed property "region" in the "sales" namespace, include entries such as "type", "owner", and "sales.region".
Related Name
nav.search.default_facets
Default Value
API Name
nav_search_default_facets
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

Policies

Enable Expression Input

Description
Allows policy properties to be specified using Java expressions.
Related Name
nav.policy.expression.enable
Default Value
false
API Name
nav_policies_expression_input
Required
false

JMS Password

Description
The password of the JMS user to which notifications of changes to entities affected by policies are sent.
Related Name
navms.jms.password
Default Value
******
API Name
nav_policies_jms_password
Required
false

JMS Queue

Description
The JMS queue to which notifications of changes to entities affected by policies are sent.
Related Name
navms.jms.queue
Default Value
Navigator
API Name
nav_policies_jms_queue
Required
false

JMS URL

Description
The URL of the JMS server to which notifications of changes to entities affected by policies are sent.
Related Name
navms.jms.url
Default Value
tcp://localhost:61616
API Name
nav_policies_jms_url
Required
false

JMS User

Description
The JMS user to which notifications of changes to entities affected by policies are sent.
Related Name
navms.jms.user
Default Value
admin
API Name
nav_policies_jms_user
Required
false

Ports and Addresses

Navigator Metadata Server Port

Description
The port where Navigator Metadata Server listens for requests
Related Name
nav.http.port
Default Value
7187
API Name
navigator_server_port
Required
false

Resource Management

Java Heap Size of Navigator Metadata Server 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
navigator_heapsize
Required
false

Cgroup CPU Shares

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

Custom Control Group Resources (overrides Cgroup settings)

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

Cgroup I/O Weight

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

Cgroup Memory Hard Limit

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

Cgroup Memory Soft Limit

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

Security

Navigator Kerberos Principal

Description
Kerberos principal used by Navigator to authenticate to all services except HDFS. Note: Navigator should use the principal used by Hue service if you are using MapReduce1 service in any of the clusters.
Related Name
Default Value
hue
API Name
kerberos_role_princ_name
Required
true

Navigator Kerberos Principal for HDFS

Description
Kerberos principal used by Navigator to authenticate to HDFS services. Note: This principal must have administrator and superuser privileges on all HDFS services.
Related Name
Default Value
hdfs
API Name
nav_hdfs_kerberos_princ
Required
true

Enable TLS/SSL for Navigator Metadata Server

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

TLS/SSL Keystore Key Password

Description
The password that protects the private key contained in the keystore used when Navigator Metadata Server is acting as a TLS/SSL server.
Related Name
nav.ssl.keyManagerPassword
Default Value
API Name
ssl_server_keystore_keypassword
Required
false

TLS/SSL 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 Navigator Metadata Server is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name
nav.ssl.keyStorePath
Default Value
API Name
ssl_server_keystore_location
Required
false

TLS/SSL Keystore File Password

Description
The password for the Navigator Metadata Server keystore file.
Related Name
nav.ssl.keyStorePassword
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 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
role_config_suppression_audit_event_log_dir
Required
true

Suppress Configuration Validator: CDH Version Validator

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

Suppress Parameter Validation: Navigator Metadata Server Storage Dir

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Metadata Server Storage Dir parameter.
Related Name
Default Value
false
API Name
role_config_suppression_data_dir
Required
true

Suppress Parameter Validation: Navigator Kerberos Principal

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

Suppress Parameter Validation: Navigator Metadata Server Logging Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Metadata 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: Rules to Extract Events from Log Files

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Rules to Extract Events from Log Files parameter.
Related Name
Default Value
false
API Name
role_config_suppression_log_event_whitelist
Required
true

Suppress Parameter Validation: Navigator Metadata Server Log Directory

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

Suppress Parameter Validation: HDFS Filter Blacklist

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the HDFS Filter Blacklist parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_filter_hdfs_rules
Required
true

Suppress Parameter Validation: S3 Filter list

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Filter list parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_filter_s3_rules
Required
true

Suppress Parameter Validation: Navigator Kerberos Principal for HDFS

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

Suppress Parameter Validation: Navigator Metadata Server Install Dir

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Metadata Server Install Dir parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_install_dir
Required
true

Suppress Parameter Validation: LDAP Bind User Distinguished Name

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Bind User Distinguished Name parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_ldap_bind_dn
Required
true

Suppress Parameter Validation: LDAP Bind Password

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

Suppress Parameter Validation: LDAP Distinguished Name Pattern

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

Suppress Parameter Validation: LDAP Group Search Base

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Group Search Base parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_ldap_group_search_base
Required
true

Suppress Parameter Validation: LDAP Group Search Filter For Logged In User

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Group Search Filter For Logged In User parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_ldap_group_search_filter
Required
true

Suppress Parameter Validation: LDAP Groups Search Filter

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP Groups Search Filter parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_ldap_groups_search_filter
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
role_config_suppression_nav_ldap_url
Required
true

Suppress Parameter Validation: LDAP User Search Base

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP User Search Base parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_ldap_user_search_base
Required
true

Suppress Parameter Validation: LDAP User Search Filter

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP User Search Filter parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_ldap_user_search_filter
Required
true

Suppress Parameter Validation: Navigator Metadata Server Database Hostname

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Metadata Server Database Hostname parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_metaserver_database_host
Required
true

Suppress Parameter Validation: Navigator Metadata Server Database Name

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Metadata Server Database Name parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_metaserver_database_name
Required
true

Suppress Parameter Validation: Navigator Metadata Server Database Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Metadata Server Database Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_metaserver_database_password
Required
true

Suppress Parameter Validation: Navigator Metadata Server Database Username

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Metadata Server Database Username parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_metaserver_database_user
Required
true

Suppress Parameter Validation: Active Directory Domain

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

Suppress Parameter Validation: JMS Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the JMS Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_policies_jms_password
Required
true

Suppress Parameter Validation: JMS Queue

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the JMS Queue parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_policies_jms_queue
Required
true

Suppress Parameter Validation: JMS URL

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

Suppress Parameter Validation: JMS User

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

Suppress Parameter Validation: SAML Entity Base URL

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SAML Entity Base URL parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_saml_entity_base_url
Required
true

Suppress Parameter Validation: SAML Entity ID

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SAML Entity ID parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_saml_entity_id
Required
true

Suppress Parameter Validation: Alias of SAML Sign/Encrypt Private Key

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Alias of SAML Sign/Encrypt Private Key parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_saml_key_alias
Required
true

Suppress Parameter Validation: SAML Sign/Encrypt Private Key Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SAML Sign/Encrypt Private Key Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_saml_key_password
Required
true

Suppress Parameter Validation: SAML Keystore Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SAML Keystore Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_saml_keystore_password
Required
true

Suppress Parameter Validation: Path to SAML Keystore File

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Path to SAML Keystore File parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_saml_keystore_path
Required
true

Suppress Parameter Validation: SAML Login URL

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

Suppress Parameter Validation: Path to SAML IDP Metadata File

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Path to SAML IDP Metadata File parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_saml_metadata_path
Required
true

Suppress Parameter Validation: SAML Attribute Identifier for User Role

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SAML Attribute Identifier for User Role parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_saml_oid_role
Required
true

Suppress Parameter Validation: SAML Attribute Identifier for User ID

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SAML Attribute Identifier for User ID parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_saml_oid_user
Required
true

Suppress Parameter Validation: SAML Attribute Values for Roles

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SAML Attribute Values for Roles parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_saml_role_map
Required
true

Suppress Parameter Validation: Path to SAML Role Assignment Script

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Path to SAML Role Assignment Script parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_saml_role_script
Required
true

Suppress Parameter Validation: Default Facets

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

Suppress Parameter Validation: Cloudera Telemetry Publisher S3 Bucket

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Cloudera Telemetry Publisher S3 Bucket parameter.
Related Name
Default Value
false
API Name
role_config_suppression_nav_telemetry_bucket_name
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
role_config_suppression_navigator_audit_event_filter
Required
true

Suppress Parameter Validation: Navigator Metadata Server 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 Navigator Metadata Server Client Advanced Configuration Snippet (Safety Valve) for navigator.client.properties parameter.
Related Name
Default Value
false
API Name
role_config_suppression_navigator_client_config_safety_valve
Required
true

Suppress Parameter Validation: Java Configuration Options for Navigator Metadata Server

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

Suppress Parameter Validation: Navigator Metadata Server Advanced Configuration Snippet (Safety Valve) for cloudera-navigator.properties

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Metadata Server Advanced Configuration Snippet (Safety Valve) for cloudera-navigator.properties parameter.
Related Name
Default Value
false
API Name
role_config_suppression_navigator_safety_valve
Required
true

Suppress Parameter Validation: Navigator Metadata Server Port

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

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

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Navigator Metadata Server Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_navigatormetaserver_role_env_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: 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: TLS/SSL Keystore Key Password

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

Suppress Parameter Validation: TLS/SSL Keystore File Location

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

Suppress Parameter Validation: TLS/SSL Keystore File Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the TLS/SSL 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 Log Directory Free Space

Description
Whether to suppress the results of the Audit 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_navigatormetaserver_audit_event_log_directory_free_space
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_navigatormetaserver_audit_health
Required
true

Suppress Health Test: Navigator Metadata Server Storage Dir Free Space

Description
Whether to suppress the results of the Navigator Metadata Server Storage Dir 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_navigatormetaserver_data_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_navigatormetaserver_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_navigatormetaserver_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_navigatormetaserver_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_navigatormetaserver_log_directory_free_space
Required
true

Suppress Health Test: Process Status

Description
Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_navigatormetaserver_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_navigatormetaserver_swap_memory_usage
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_navigatormetaserver_unexpected_exits
Required
true

Suppress Health Test: Solr Element Count Threshold Test

Description
Whether to suppress the results of the Solr Element Count Threshold 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_nms_solr_element_count
Required
true

Suppress Health Test: Solr Relation Count Threshold Test

Description
Whether to suppress the results of the Solr Relation Count Threshold 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_nms_solr_relation_count
Required
true

Reports Manager

Advanced

Java Configuration Options for Reports Manager

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

Maximum Document Buffer Size

Description
Amount of memory that can be used for buffering documents before they are flushed to the index. For faster indexing performance, consider increasing this value.
Related Name
lucene.max.buffer.size.mb
Default Value
32 MiB
API Name
headlamp_lucene_max_buffer_size_mb
Required
false

Index Merge Factor

Description
Reports Manager index is built in sections that are merged as the build progresses. This configuration determines how often index sections are merged. With smaller values, less memory is used while indexing, but indexing speed is slower. For faster indexing performance, consider increasing this value.
Related Name
lucene.merge.factor
Default Value
100
API Name
headlamp_lucene_merge_factor
Required
false

Publish HBase Space Usage

Description
When set, publishes HBase space usage metrics to support HBase usage reporting. This feature is only supported for the HBase service in CDH 5 and higher.
Related Name
publish.hbase.space
Default Value
true
API Name
headlamp_publish_hbase_metrics
Required
false

Reports Manager 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

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 heap dump file when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value
true
API Name
oom_heap_dump_enabled
Required
true

Kill When Out of Memory

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

Automatically Restart Process

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

Enable Metric Collection

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

Process Start Retry Attempts

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

Process Start Wait Timeout

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

Reports Manager Advanced Configuration Snippet (Safety Valve) for headlamp.db.properties

Description
For advanced use only. A string to be inserted into headlamp.db.properties for this role only.
Related Name
Default Value
API Name
reportsmanager_db_safety_valve
Required
false

Reports Manager 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
REPORTSMANAGER_role_env_safety_valve
Required
false

Reports Manager Advanced Configuration Snippet (Safety Valve) for headlamp.conf

Description
For advanced use only. A string to be inserted into headlamp.conf for this role only.
Related Name
Default Value
API Name
reportsmanager_safety_valve
Required
false

Database

Reports Manager Database Hostname

Description
Name of the host where Reports Manager's database is running. It is highly recommended that this database is on the same host as Reports Manager. If the database is not running on its default port, specify the port number using this syntax: 'host:port'
Related Name
com.cloudera.headlamp.db.host
Default Value
localhost
API Name
headlamp_database_host
Required
false

Reports Manager Database Name

Description
The name of the Reports Manager's database.
Related Name
com.cloudera.headlamp.db.name
Default Value
headlamp
API Name
headlamp_database_name
Required
true

Reports Manager Database Password

Description
The password for Reports Manager's database user account.
Related Name
com.cloudera.headlamp.db.password
Default Value
API Name
headlamp_database_password
Required
false

Reports Manager Database Type

Description
Type of database used for Reports Manager.
Related Name
com.cloudera.headlamp.db.type
Default Value
mysql
API Name
headlamp_database_type
Required
false

Reports Manager Database Username

Description
The username to use to log into Reports Manager's database.
Related Name
com.cloudera.headlamp.db.user
Default Value
headlamp
API Name
headlamp_database_user
Required
true

Logs

Reports Manager Logging Threshold

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

Reports Manager Maximum Log File Backups

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

Reports Manager Max Log Size

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

Reports Manager Log Directory

Description
Directory where Reports Manager will place its log files.
Related Name
Default Value
/var/log/cloudera-scm-headlamp
API Name
mgmt_log_dir
Required
false

Monitoring

Enable Health Alerts for this Role

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

Enable Configuration Change Alerts

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

Heap Dump Directory Free Space Monitoring Absolute Thresholds

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

Heap Dump Directory Free Space Monitoring Percentage Thresholds

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

Log Directory Free Space Monitoring Absolute Thresholds

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

Log Directory Free Space Monitoring Percentage Thresholds

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

Rules to Extract Events from Log Files

Description
This file contains the rules that govern how log messages are turned into events by the custom log4j appender that this role loads. It is in JSON format, and is composed of a list of rules. Every log message is evaluated against each of these rules in turn to decide whether or not to send an event for that message. If a log message matches multiple rules, the first matching rule is used.. Each rule has some or all of the following fields:
  • alert - whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".
  • rate (mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more than rate matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.
  • periodminutes - the number of minutes during which the publisher will only publish rate events or fewer. If not specified, the default is one minute
  • threshold - apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.
  • content - match only those messages for which contents match this regular expression.
  • exceptiontype - match only those messages that are part of an exception message. The exception type must match this regular expression.
Example:
  • {"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}This rule sends events to Cloudera Manager for every StringIndexOutOfBoundsException, up to a maximum of 10 every minute.
  • {"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.
Related Name
Default Value
version: 0, rules: [ alert: false, rate: 1, periodminutes: 1, threshold: FATAL , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Instead, use .* , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Use .* instead , alert: false, rate: 1, periodminutes: 2, exceptiontype: .* , alert: false, rate: 1, periodminutes: 1, threshold: WARN ]
API Name
log_event_whitelist
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

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

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
reportsmanager_fd_thresholds
Required
false

Reports Manager Host Health Test

Description
When computing the overall Reports Manager health, consider the host's health.
Related Name
Default Value
true
API Name
reportsmanager_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
reportsmanager_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
reportsmanager_pause_duration_window
Required
false

Reports Manager Process Health Test

Description
Enables the health test that the Reports Manager's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
reportsmanager_scm_health_enabled
Required
false

Reports Manager Working Directory Free Space Monitoring Absolute Thresholds

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

Reports Manager Working Directory Free Space Monitoring Percentage Thresholds

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

Cloudera Manager Descriptor Age Thresholds

Description
The health test thresholds for monitoring the time since the Cloudera Manager descriptor was last refreshed.
Related Name
Default Value
Warning: 60000.0, Critical: 120000.0
API Name
scm_descriptor_age_thresholds
Required
false

Unexpected Exits Thresholds

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

Unexpected Exits Monitoring Period

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

Other

Reports Manager Working Directory

Description
Directory for Reports Manager to use for its working files
Related Name
scratch.dir
Default Value
/var/lib/cloudera-scm-headlamp
API Name
headlamp_scratch_dir
Required
false

Reports Manager Update Frequency

Description
Frequency in which Reports Manager refreshes its view of HDFS.
Related Name
update.frequency.seconds
Default Value
1 hour(s)
API Name
headlamp_update_frequency_seconds
Required
false

Starting Interval for Descriptor Fetch Attempts

Description
The starting interval between fetch attempts for the SCM descriptor when Cloudera Management Service roles are starting. The interval is increased by an additional one second with each failed fetch attempt.
Related Name
mgmt.descriptor.fetch.frequency
Default Value
2 second(s)
API Name
mgmt_descriptor_fetch_frequency
Required
true

Descriptor Fetch Max Attempts

Description
Maximum number of attempts to fetch the SCM descriptor when Cloudera Management Service roles are starting. If the roles are not able to get the descriptor in this number of attempts, then the roles exit.
Related Name
mgmt.num.descriptor.fetch.tries
Default Value
10
API Name
mgmt_num_descriptor_fetch_tries
Required
true

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

Bind Reports Manager to Wildcard Address

Description
If enabled, the Reports Manager binds to the wildcard address ("0.0.0.0") on all of its ports.
Related Name
Default Value
false
API Name
headlamp_bind_wildcard
Required
false

Reports Manager Web UI Port

Description
The port where Reports Manager starts a debug web server. Set to -1 to disable debug server.
Related Name
debug.server.port
Default Value
8083
API Name
headlamp_debug_port
Required
false

Reports Manager Server Port

Description
The port where Reports Manager listens for requests
Related Name
server.port
Default Value
5678
API Name
headlamp_server_port
Required
false

Resource Management

Java Heap Size of Reports Manager in Bytes

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

Cgroup CPU Shares

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

Custom Control Group Resources (overrides Cgroup settings)

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

Cgroup I/O Weight

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

Cgroup Memory Hard Limit

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

Cgroup Memory Soft Limit

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

Security

Reports Manager Kerberos Principal

Description
Kerberos principal used by Reports Manager. Note: This principal must have administrator and superuser privileges on all HDFS services.
Related Name
Default Value
hdfs
API Name
kerberos_role_princ_name
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: Reports Manager Database Hostname

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Reports Manager Database Hostname parameter.
Related Name
Default Value
false
API Name
role_config_suppression_headlamp_database_host
Required
true

Suppress Parameter Validation: Reports Manager Database Name

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Reports Manager Database Name parameter.
Related Name
Default Value
false
API Name
role_config_suppression_headlamp_database_name
Required
true

Suppress Parameter Validation: Reports Manager Database Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Reports Manager Database Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_headlamp_database_password
Required
true

Suppress Parameter Validation: Reports Manager Database Username

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Reports Manager Database Username parameter.
Related Name
Default Value
false
API Name
role_config_suppression_headlamp_database_user
Required
true

Suppress Parameter Validation: Reports Manager Web UI Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Reports Manager Web UI Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_headlamp_debug_port
Required
true

Suppress Parameter Validation: Java Configuration Options for Reports Manager

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

Suppress Parameter Validation: Reports Manager Working Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Reports Manager Working Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_headlamp_scratch_dir
Required
true

Suppress Parameter Validation: Reports Manager Server Port

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

Suppress Parameter Validation: Reports Manager Kerberos Principal

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

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

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Reports Manager 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: Rules to Extract Events from Log Files

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Rules to Extract Events from Log Files parameter.
Related Name
Default Value
false
API Name
role_config_suppression_log_event_whitelist
Required
true

Suppress Parameter Validation: Reports Manager Log Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Reports Manager Log Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_mgmt_log_dir
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: Reports Manager Advanced Configuration Snippet (Safety Valve) for headlamp.db.properties

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Reports Manager Advanced Configuration Snippet (Safety Valve) for headlamp.db.properties parameter.
Related Name
Default Value
false
API Name
role_config_suppression_reportsmanager_db_safety_valve
Required
true

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

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

Suppress Parameter Validation: Reports Manager Advanced Configuration Snippet (Safety Valve) for headlamp.conf

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Reports Manager Advanced Configuration Snippet (Safety Valve) for headlamp.conf parameter.
Related Name
Default Value
false
API Name
role_config_suppression_reportsmanager_safety_valve
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_reports_manager_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_reports_manager_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_reports_manager_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_reports_manager_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_reports_manager_log_directory_free_space
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_reports_manager_pause_duration
Required
true

Suppress Health Test: Cloudera Manager Descriptor Age

Description
Whether to suppress the results of the Cloudera Manager Descriptor Age 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_reports_manager_scm_descriptor_fetch
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_reports_manager_scm_health
Required
true

Suppress Health Test: Reports Manager Working Directory Free Space

Description
Whether to suppress the results of the Reports Manager Working 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_reports_manager_scratch_directory_free_space
Required
true

Suppress Health Test: Swap Memory Usage

Description
Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_reports_manager_swap_memory_usage
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_reports_manager_unexpected_exits
Required
true

Service Monitor

Advanced

Java Configuration Options for Service Monitor

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

Service Monitor Advanced Configuration Snippet (Safety Valve) for cmon.conf

Description
For advanced use only. A string to be inserted into cmon.conf for this role only.
Related Name
Default Value
API Name
firehose_safety_valve
Required
false

Service Monitor 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

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 heap dump file when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value
true
API Name
oom_heap_dump_enabled
Required
true

Kill When Out of Memory

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

Automatically Restart Process

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

Enable Metric Collection

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

Process Start Retry Attempts

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

Process Start Wait Timeout

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

Service Monitor 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
SERVICEMONITOR_role_env_safety_valve
Required
false

Event Publication Maximum Queue Size

Description
The maximum size of the queue in which events published from this role will be buffered. If this queue becomes full (for example, due to an outage), subsequent events will be dropped.
Related Name
health.event.publish.queue.max
Default Value
20000
API Name
svcmon_event_publication_queue_size_max
Required
true

Event Publication Retry Period

Description
If an event cannot be delivered immediately by this role, this value controls how long to wait before Event Publisher retries delivery.
Related Name
health.event.publish.retry.ms
Default Value
5000
API Name
svcmon_event_publication_retry_period
Required
true

Logs

Service Monitor Logging Threshold

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

Service Monitor Maximum Log File Backups

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

Service Monitor Max Log Size

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

Service Monitor Log Directory

Description
Location of log files for Service Monitor
Related Name
Default Value
/var/log/cloudera-scm-firehose
API Name
mgmt_log_dir
Required
false

Monitoring

Metrics Aggregation Run Duration Thresholds

Description
The health test thresholds for monitoring the metrics aggregation run duration.
Related Name
Default Value
Warning: 10 second(s), Critical: 30 second(s)
API Name
aggregation_run_duration_thresholds
Required
false

Enable Health Alerts for this Role

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

Enable Configuration Change Alerts

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

Service Monitor Storage Directory Free Space Monitoring Absolute Thresholds

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

Service Monitor Storage Directory Free Space Monitoring Percentage Thresholds

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

Heap Dump Directory Free Space Monitoring Absolute Thresholds

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

Heap Dump Directory Free Space Monitoring Percentage Thresholds

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

Log Directory Free Space Monitoring Absolute Thresholds

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

Log Directory Free Space Monitoring Percentage Thresholds

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

Rules to Extract Events from Log Files

Description
This file contains the rules that govern how log messages are turned into events by the custom log4j appender that this role loads. It is in JSON format, and is composed of a list of rules. Every log message is evaluated against each of these rules in turn to decide whether or not to send an event for that message. If a log message matches multiple rules, the first matching rule is used.. Each rule has some or all of the following fields:
  • alert - whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".
  • rate (mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more than rate matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.
  • periodminutes - the number of minutes during which the publisher will only publish rate events or fewer. If not specified, the default is one minute
  • threshold - apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.
  • content - match only those messages for which contents match this regular expression.
  • exceptiontype - match only those messages that are part of an exception message. The exception type must match this regular expression.
Example:
  • {"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}This rule sends events to Cloudera Manager for every StringIndexOutOfBoundsException, up to a maximum of 10 every minute.
  • {"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.
Related Name
Default Value
version: 0, rules: [ alert: false, rate: 1, periodminutes: 1, threshold: FATAL , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Instead, use .* , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Use .* instead , alert: false, rate: 1, periodminutes: 2, exceptiontype: .* , alert: false, rate: 1, periodminutes: 1, threshold: WARN ]
API Name
log_event_whitelist
Required
false

Cloudera Manager Metric Schema Age Thresholds

Description
The health test thresholds for monitoring the time since the Cloudera Manager metric schema was last refreshed.
Related Name
Default Value
Warning: 60000.0, Critical: 120000.0
API Name
metric_schema_age_thresholds_name
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

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

Cloudera Manager Descriptor Age Thresholds

Description
The health test thresholds for monitoring the time since the Cloudera Manager descriptor was last refreshed.
Related Name
Default Value
Warning: 60000.0, Critical: 120000.0
API Name
scm_descriptor_age_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
servicemonitor_fd_thresholds
Required
false

Heap Size Thresholds

Description
The health test thresholds for the heap used.
Related Name
Default Value
Warning: 90.0 %, Critical: 95.0 %
API Name
servicemonitor_heap_size_thresholds
Required
false

Service Monitor Host Health Test

Description
When computing the overall Service Monitor health, consider the host's health.
Related Name
Default Value
true
API Name
servicemonitor_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
servicemonitor_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
servicemonitor_pause_duration_window
Required
false

Service Monitor Role Pipeline Monitoring Thresholds

Description
The health test thresholds for monitoring the Service Monitor role pipeline. This specifies the number of dropped messages that will be tolerated over the monitoring time period.
Related Name
Default Value
Warning: Never, Critical: Any
API Name
servicemonitor_role_pipeline_thresholds
Required
false

Service Monitor Role Pipeline Monitoring Time Period

Description
The time period over which the Service Monitor role pipeline will be monitored for dropped messages.
Related Name
Default Value
5 minute(s)
API Name
servicemonitor_role_pipeline_window
Required
false

Service Monitor Process Health Test

Description
Enables the health test that the Service Monitor's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
servicemonitor_scm_health_enabled
Required
false

Web Metric Collection

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

Web Metric Collection Duration

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

Unexpected Exits Thresholds

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

Unexpected Exits Monitoring Period

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

YARN MapReduce Counter Descriptions

Description
This JSON document contains metadata that is used by the Service Monitor's YARN application monitoring feature for YARN-based MapReduce counter handling. Each counter description has the following fields:
  • name (mandatory) - the name of the counter, for example, org.apache.hadoop.mapreduce.filesystemcounter.file_bytes_read.
  • units (mandatory) - the units of the counter.
  • attributeName (optional) - the attribute name to use for the counter within Cloudera Manager, this name will be used to identify the counter within the YARN Application Monitoring feature and in the Cloudera Manager API. If not specified the portion of the counter name after the last period will be used.
  • displayName (optional) - a display name for the counter. If not specified the full counter name will be used.
  • description (optional) - a description of the counter. If not specified the full counter name will be used.
Related Name
Default Value
[ name: org.apache.hadoop.mapreduce.jobcounter.num_failed_maps, units: tasks , name: org.apache.hadoop.mapreduce.jobcounter.num_failed_reduces, units: tasks , name: org.apache.hadoop.mapreduce.jobcounter.total_launched_maps, units: tasks , name: org.apache.hadoop.mapreduce.jobcounter.total_launched_reduces, units: tasks , name: org.apache.hadoop.mapreduce.jobcounter.other_local_maps, units: tasks , name: org.apache.hadoop.mapreduce.jobcounter.data_local_maps, units: tasks , name: org.apache.hadoop.mapreduce.jobcounter.rack_local_maps, units: tasks , name: org.apache.hadoop.mapreduce.jobcounter.slots_millis_maps, units: ms , name: org.apache.hadoop.mapreduce.jobcounter.slots_millis_reduces, units: ms , name: org.apache.hadoop.mapreduce.jobcounter.fallow_slots_millis_maps, units: ms , name: org.apache.hadoop.mapreduce.jobcounter.fallow_slots_millis_reduces, units: ms , name: org.apache.hadoop.mapreduce.jobcounter.mb_millis_maps, units: mb millis , name: org.apache.hadoop.mapreduce.jobcounter.mb_millis_reduces, units: mb millis , name: org.apache.hadoop.mapreduce.jobcounter.vcores_millis_maps, units: vcore millis , name: org.apache.hadoop.mapreduce.jobcounter.vcores_millis_reduces, units: vcore millis , name: org.apache.hadoop.mapreduce.filesystemcounter.file_bytes_read, units: bytes , name: org.apache.hadoop.mapreduce.filesystemcounter.file_bytes_written, units: bytes , name: org.apache.hadoop.mapreduce.filesystemcounter.file_read_ops, units: operations , name: org.apache.hadoop.mapreduce.filesystemcounter.file_large_read_ops, units: operations , name: org.apache.hadoop.mapreduce.filesystemcounter.file_write_ops, units: operations , name: org.apache.hadoop.mapreduce.filesystemcounter.hdfs_bytes_read, units: bytes , name: org.apache.hadoop.mapreduce.filesystemcounter.hdfs_bytes_written, units: bytes , name: org.apache.hadoop.mapreduce.filesystemcounter.hdfs_read_ops, units: operations , name: org.apache.hadoop.mapreduce.filesystemcounter.hdfs_large_read_ops, units: operations , name: org.apache.hadoop.mapreduce.filesystemcounter.hdfs_write_ops, units: operations , name: org.apache.hadoop.mapreduce.filesystemcounter.s3a_bytes_read, units: bytes , name: org.apache.hadoop.mapreduce.filesystemcounter.s3a_bytes_written, units: bytes , name: org.apache.hadoop.mapreduce.filesystemcounter.adl_bytes_read, units: bytes , name: org.apache.hadoop.mapreduce.filesystemcounter.adl_bytes_written, units: bytes , name: org.apache.hadoop.mapreduce.taskcounter.map_input_records, units: records , name: org.apache.hadoop.mapreduce.taskcounter.map_output_records, units: records , name: org.apache.hadoop.mapreduce.taskcounter.map_output_bytes, units: bytes , name: org.apache.hadoop.mapreduce.taskcounter.map_output_materialized_bytes, units: bytes , name: org.apache.hadoop.mapreduce.taskcounter.split_raw_bytes, units: bytes , name: org.apache.hadoop.mapreduce.taskcounter.combine_input_records, units: records , name: org.apache.hadoop.mapreduce.taskcounter.combine_output_records, units: records , name: org.apache.hadoop.mapreduce.taskcounter.reduce_input_groups, units: groups , name: org.apache.hadoop.mapreduce.taskcounter.reduce_shuffle_bytes, units: bytes , name: org.apache.hadoop.mapreduce.taskcounter.reduce_input_records, units: records , name: org.apache.hadoop.mapreduce.taskcounter.reduce_output_records, units: records , name: org.apache.hadoop.mapreduce.taskcounter.spilled_records, units: records , name: org.apache.hadoop.mapreduce.taskcounter.shuffled_maps, units: tasks , name: org.apache.hadoop.mapreduce.taskcounter.failed_shuffle, units: failures , name: org.apache.hadoop.mapreduce.taskcounter.merged_map_outputs, units: outputs , name: org.apache.hadoop.mapreduce.taskcounter.gc_time_millis, units: ms , name: org.apache.hadoop.mapreduce.taskcounter.cpu_milliseconds, units: ms , name: org.apache.hadoop.mapreduce.taskcounter.physical_memory_bytes, units: bytes , name: org.apache.hadoop.mapreduce.taskcounter.virtual_memory_bytes, units: bytes , name: org.apache.hadoop.mapreduce.taskcounter.committed_heap_bytes, units: bytes , attributeName: shuffle_errors_bad_id, name: shuffle_errors.bad_id, units: errors , attributeName: shuffle_errors_connection, name: shuffle_errors.connection, units: errors , attributeName: shuffle_errors_io, name: shuffle_errors.io_error, units: errors , attributeName: shuffle_errors_wrong_length, name: shuffle_errors.wrong_length, units: errors , attributeName: shuffle_errors_wrong_map, name: shuffle_errors.wrong_map, units: errors , attributeName: shuffle_errors_wrong_reduce, name: shuffle_errors.wrong_reduce, units: errors , name: org.apache.hadoop.mapreduce.lib.input.fileinputformatcounter.bytes_read, units: bytes , name: org.apache.hadoop.mapreduce.lib.output.fileoutputformatcounter.bytes_written, units: bytes ]
API Name
yarn_application_mapreduce_counters
Required
false

Other

Use the Authentication Service to enable Single Sign On

Description
Use the Authentication Service to enable Single Sign On for the Firehose debug servers. Requires a running Authentication Service.
Related Name
debug.servlet.auth.enabled
Default Value
false
API Name
debug_servlet_auth_enabled
Required
false

Impala Storage

Description
The approximate amount of disk space dedicated to storing Impala query data. Once the store has reached its maximum size, older data is deleted to make room for newer queries. The disk usage is approximate because data is deleted only when the limit is reached.
Related Name
firehose_impala_storage_bytes
Default Value
1 GiB
API Name
firehose_impala_storage_bytes
Required
false

Reports Time-series Storage

Description
The approximate amount of disk space dedicated to storing time series for reporting data. Once the store has reached its maximum size, older data is deleted to make room for newer data. The disk usage is approximate because data is deleted only when the limit is reached. See the "Disk Usage" tab on the Service Monitor page for more information on how space is consumed in the Service Monitor. This tab also shows information about the amount of data retained and the time window covered by each data granularity.
Related Name
firehose_reports_storage_bytes
Default Value
1 GiB
API Name
firehose_reports_storage_bytes
Required
false

Service Monitor Storage Directory

Description
The directory where Service Monitor data is stored. The Service Monitor stores metric time series and health information, as well as Impala query and YARN application metadata if Impala and/or YARN are configured.
Related Name
firehose.storage.base.directory
Default Value
/var/lib/cloudera-service-monitor
API Name
firehose_storage_dir
Required
true

Time-Series Storage

Description
The approximate amount of disk space dedicated to storing time series and health data. Once the store has reached its maximum size, older data is deleted to make room for newer data. The disk usage is approximate because data is deleted only when the limit is reached.Note that Cloudera Manager stores time-series data at a number of different data granularities, and these granularities have different effective retention periods. Specifically, Cloudera Manager stores metric data as both raw data points and ten-minutely, hourly, six-hourly, daily, and weekly summary data points. Raw data consumes the bulk of the allocated storage space, weekly summaries the least. As such, raw data is retained for the shortest amount of time, while weekly summary points are unlikely to ever be deleted.See the "Storage" tab on the 'Service Monitor' -> 'Charts Library' -> 'Service Monitor Storage' page for more information on how space is consumed within the Service Monitor. This tab also shows information about the amount of data retained and time window covered by each data granularity.
Related Name
firehose_time_series_storage_bytes
Default Value
10 GiB
API Name
firehose_time_series_storage_bytes
Required
false

YARN Storage

Description
The approximate amount of disk space dedicated to storing YARN application data. Once the store has reached its maximum size, older data is deleted to make room for newer applications. The disk usage is approximate because data is deleted only when the limit is reached.
Related Name
firehose_yarn_storage_bytes
Default Value
1 GiB
API Name
firehose_yarn_storage_bytes
Required
false

Health Event Startup Policy

Description
This setting controls whether health events are emitted when this monitoring role is started. If set to "none", then no health events are emitted. If set to "bad" then health events are emitted for subjects with bad or concerning health. If set to "all" then health events are emitted for all subjects for all health values. The default is "bad".
Related Name
health.event.publish.startup.policy
Default Value
bad
API Name
health_event_publish_startup_policy
Required
false

Starting Interval for Descriptor Fetch Attempts

Description
The starting interval between fetch attempts for the SCM descriptor when Cloudera Management Service roles are starting. The interval is increased by an additional one second with each failed fetch attempt.
Related Name
mgmt.descriptor.fetch.frequency
Default Value
2 second(s)
API Name
mgmt_descriptor_fetch_frequency
Required
true

Descriptor Fetch Max Attempts

Description
Maximum number of attempts to fetch the SCM descriptor when Cloudera Management Service roles are starting. If the roles are not able to get the descriptor in this number of attempts, then the roles exit.
Related Name
mgmt.num.descriptor.fetch.tries
Default Value
10
API Name
mgmt_num_descriptor_fetch_tries
Required
true

Event Publication Log Quiet Time Period

Description
To avoid producing excessive amounts of log output, the Event Publisher component of this role is limited to emitting one message per time period. This value controls the size of that time period.
Related Name
health.event.publish.log.suppress.window.ms
Default Value
1 minute(s)
API Name
svcmon_event_publication_log_suppress_window
Required
true

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

Service Monitor Web UI Port

Description
Port for Service Monitor's Debug page. Set to -1 to disable the debug server.
Related Name
debug.servlet.port
Default Value
8086
API Name
firehose_debug_port
Required
false

Service Monitor Web UI HTTPS Port

Description
Port for Service Monitor's HTTPS Debug page.
Related Name
debug.servlet.https.port
Default Value
9086
API Name
firehose_debug_tls_port
Required
false

Service Monitor Listen Port

Description
Port where Service Monitor is listening for agent messages.
Related Name
firehose.server.port
Default Value
9997
API Name
firehose_listen_port
Required
false

Service Monitor Nozzle Port

Description
Port where Service Monitor's query API is exposed.
Related Name
nozzle.server.port
Default Value
9996
API Name
firehose_nozzle_port
Required
false

Bind Service Monitor to Wildcard Address

Description
If enabled, the Service Monitor binds to the wildcard address ("0.0.0.0") on all of its ports.
Related Name
Default Value
false
API Name
smon_bind_wildcard
Required
false

Resource Management

Java Heap Size of Service Monitor in Bytes

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

Maximum Non-Java Memory of Service Monitor

Description
The amount of memory the Service Monitor can use off of the Java heap.
Related Name
firehose_non_java_memory_bytes
Default Value
2 GiB
API Name
firehose_non_java_memory_bytes
Required
false

Cgroup CPU Shares

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

Custom Control Group Resources (overrides Cgroup settings)

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

Cgroup I/O Weight

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

Cgroup Memory Hard Limit

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

Cgroup Memory Soft Limit

Description
Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only i