Phoenix Properties in CDH 7.0.2

Role groups:

Query Server

Categories:

Advanced


Display Name	Description	Related Name	Default Value	API Name	Required
Query Server Logging Advanced Configuration Snippet (Safety Valve)	For advanced use only, a string to be inserted into log4j.properties for this role only.			`log4j_safety_valve`	false
Heap Dump Directory	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, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. 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.	`oom_heap_dump_dir`	/tmp	`oom_heap_dump_dir`	false
Dump Heap When Out of Memory	When set, generates heap dump file when java.lang.OutOfMemoryError is thrown.		true	`oom_heap_dump_enabled`	true
Kill When Out of Memory	When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.		true	`oom_sigkill_enabled`	true
Query Server Advanced Configuration Snippet (Safety Valve) for phoenix-site.xml	For advanced use only. A string to be inserted into phoenix-site.xml for this role only.			`phoenix-site.xml_role_safety_valve`	false
Query Server Environment Advanced Configuration Snippet (Safety Valve)	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.			`PHOENIX_QUERY_SERVER_role_env_safety_valve`	false
Automatically Restart Process	When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure.		false	`process_auto_restart`	true
Enable Metric Collection	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.		true	`process_should_monitor`	true

Logs


Display Name	Description	Related Name	Default Value	API Name	Required
Query Server Log Directory	The log directory for log files of the role Query Server.	`log_dir`	/var/log/phoenix	`log_dir`	false
Query Server Logging Threshold	The minimum log level for Query Server logs		INFO	`log_threshold`	false
Query Server Maximum Log File Backups	The maximum number of rolled log files to keep for Query Server logs. Typically used by log4j or logback.		10	`max_log_backup_index`	false
Query Server Max Log Size	The maximum size, in megabytes, per log file for Query Server logs. Typically used by log4j or logback.		200 MiB	`max_log_size`	false

Monitoring


Display Name	Description	Related Name	Default Value	API Name	Required
Enable Health Alerts for this Role	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		true	`enable_alerts`	false
Enable Configuration Change Alerts	When set, Cloudera Manager will send alerts when this entity's configuration changes.		false	`enable_config_alerts`	false
Log Directory Free Space Monitoring Absolute Thresholds	The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.		Warning: 10 GiB, Critical: 5 GiB	`log_directory_free_space_absolute_thresholds`	false
Log Directory Free Space Monitoring Percentage Thresholds	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.		Warning: Never, Critical: Never	`log_directory_free_space_percentage_thresholds`	false
Metric Filter	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"] }`			`monitoring_metric_filter`	false
File Descriptor Monitoring Thresholds	The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.		Warning: 50.0 %, Critical: 70.0 %	`phoenix_query_server_fd_thresholds`	false
Query Server Host Health Test	When computing the overall Query Server health, consider the host's health.		true	`phoenix_query_server_host_health_enabled`	false
Query Server Process Health Test	Enables the health test that the Query Server's process state is consistent with the role configuration		true	`phoenix_query_server_scm_health_enabled`	false
Process Swap Memory Thresholds	The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.		Warning: 200 B, Critical: Never	`process_swap_memory_thresholds`	false
Role Triggers	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.		[]	`role_triggers`	true
Unexpected Exits Thresholds	The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.		Warning: Never, Critical: Any	`unexpected_exits_thresholds`	false
Unexpected Exits Monitoring Period	The period to review when computing unexpected exits.		5 minute(s)	`unexpected_exits_window`	false

Performance


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

Ports and Addresses


Display Name	Description	Related Name	Default Value	API Name	Required
Phoenix Query Server Port	The port Phoenix Query Server will listen on	`phoenix.queryserver.http.port`	8765	`phoenix_query_server_port`	false

Resource Management


Display Name	Description	Related Name	Default Value	API Name	Required
Cgroup CPU Shares	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.	`cpu.shares`	1024	`rm_cpu_shares`	true
Cgroup I/O Weight	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.	`blkio.weight`	500	`rm_io_weight`	true
Cgroup Memory Hard Limit	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'	`memory.limit_in_bytes`	-1 MiB	`rm_memory_hard_limit`	true
Cgroup Memory Soft Limit	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'	`memory.soft_limit_in_bytes`	-1 MiB	`rm_memory_soft_limit`	true

Stacks Collection


Display Name	Description	Related Name	Default Value	API Name	Required
Stacks Collection Data Retention	The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.	`stacks_collection_data_retention`	100 MiB	`stacks_collection_data_retention`	false
Stacks Collection Directory	The directory in which stacks logs are placed. If not set, stacks are logged into a `stacks` subdirectory of the role's log directory.	`stacks_collection_directory`		`stacks_collection_directory`	false
Stacks Collection Enabled	Whether or not periodic stacks collection is enabled.	`stacks_collection_enabled`	false	`stacks_collection_enabled`	true
Stacks Collection Frequency	The frequency with which stacks are collected.	`stacks_collection_frequency`	5.0 second(s)	`stacks_collection_frequency`	false
Stacks Collection Method	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.	`stacks_collection_method`	jstack	`stacks_collection_method`	false

Suppressions


Display Name	Description	Related Name	Default Value	API Name	Required
Suppress Configuration Validator: CDH Version Validator	Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.		false	`role_config_suppression_cdh_version_validator`	true
Suppress Parameter Validation: Query Server Logging Advanced Configuration Snippet (Safety Valve)	Whether to suppress configuration warnings produced by the built-in parameter validation for the Query Server Logging Advanced Configuration Snippet (Safety Valve) parameter.		false	`role_config_suppression_log4j_safety_valve`	true
Suppress Parameter Validation: Query Server Log Directory	Whether to suppress configuration warnings produced by the built-in parameter validation for the Query Server Log Directory parameter.		false	`role_config_suppression_log_dir`	true
Suppress Parameter Validation: Heap Dump Directory	Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.		false	`role_config_suppression_oom_heap_dump_dir`	true
Suppress Parameter Validation: Query Server Advanced Configuration Snippet (Safety Valve) for phoenix-site.xml	Whether to suppress configuration warnings produced by the built-in parameter validation for the Query Server Advanced Configuration Snippet (Safety Valve) for phoenix-site.xml parameter.		false	`role_config_suppression_phoenix-site.xml_role_safety_valve`	true
Suppress Parameter Validation: Phoenix Query Server Port	Whether to suppress configuration warnings produced by the built-in parameter validation for the Phoenix Query Server Port parameter.		false	`role_config_suppression_phoenix_query_server_port`	true
Suppress Parameter Validation: Query Server Environment Advanced Configuration Snippet (Safety Valve)	Whether to suppress configuration warnings produced by the built-in parameter validation for the Query Server Environment Advanced Configuration Snippet (Safety Valve) parameter.		false	`role_config_suppression_phoenix_query_server_role_env_safety_valve`	true
Suppress Parameter Validation: Role Triggers	Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.		false	`role_config_suppression_role_triggers`	true
Suppress Parameter Validation: Stacks Collection Directory	Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.		false	`role_config_suppression_stacks_collection_directory`	true
Suppress Health Test: Audit Pipeline Test	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.		false	`role_health_suppression_phoenix_phoenix_query_server_audit_health`	true
Suppress Health Test: File Descriptors	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.		false	`role_health_suppression_phoenix_phoenix_query_server_file_descriptor`	true
Suppress Health Test: Host Health	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.		false	`role_health_suppression_phoenix_phoenix_query_server_host_health`	true
Suppress Health Test: Log Directory Free Space	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.		false	`role_health_suppression_phoenix_phoenix_query_server_log_directory_free_space`	true
Suppress Health Test: Process Status	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.		false	`role_health_suppression_phoenix_phoenix_query_server_scm_health`	true
Suppress Health Test: Swap Memory Usage	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.		false	`role_health_suppression_phoenix_phoenix_query_server_swap_memory_usage`	true
Suppress Health Test: Unexpected Exits	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.		false	`role_health_suppression_phoenix_phoenix_query_server_unexpected_exits`	true

Service-Wide

Categories:

Advanced


Display Name	Description	Related Name	Default Value	API Name	Required
Phoenix Service Environment Advanced Configuration Snippet (Safety Valve)	For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of all roles in this service except client configuration.			`PHOENIX_service_env_safety_valve`	false
System Group	The group that this service's processes should run as.		phoenix	`process_groupname`	true
System User	The user that this service's processes should run as.		phoenix	`process_username`	true

Monitoring


Display Name	Description	Related Name	Default Value	API Name	Required
Enable Service Level Health Alerts	When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold		true	`enable_alerts`	false
Enable Configuration Change Alerts	When set, Cloudera Manager will send alerts when this entity's configuration changes.		false	`enable_config_alerts`	false
Healthy Query Server Monitoring Thresholds	The health test thresholds of the overall Query Server health. The check returns "Concerning" health if the percentage of "Healthy" Query Servers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Query Servers falls below the critical threshold.		Warning: 99.0 %, Critical: 90.0 %	`PHOENIX_PHOENIX_QUERY_SERVER_healthy_thresholds`	false
Service Triggers	The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields: `triggerName` (mandatory) - The name of the trigger. This value must be unique for the specific service. `triggerExpression` (mandatory) - A tsquery expression representing the trigger. `streamThreshold` (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire. `enabled` (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated. `expressionEditorConfig` (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies. For example, the following JSON formatted trigger fires if there are more than 10 DataNodes with more than 500 file descriptors opened:`[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad", "streamThreshold": 10, "enabled": "true"}]`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.		[]	`service_triggers`	true
Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)	For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones.			`smon_derived_configs_safety_valve`	false

Other


Display Name	Description	Related Name	Default Value	API Name	Required
HBase Service	Name of the HBase service that this Phoenix service instance depends on			`hbase_service`	true
HDFS Service	Name of the HDFS service that this Phoenix service instance depends on			`hdfs_service`	true
ZooKeeper Service	Name of the ZooKeeper service that this Phoenix service instance depends on			`zookeeper_service`	true

Security


Display Name	Description	Related Name	Default Value	API Name	Required
Kerberos Principal	Kerberos principal short name used by all roles of this service.		phoenix	`kerberos_princ_name`	true

Suppressions


Display Name	Description	Related Name	Default Value	API Name	Required
Suppress Configuration Validator: CDH Version Validator	Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.		false	`role_config_suppression_cdh_version_validator`	true
Suppress Configuration Validator: Query Server Logging Advanced Configuration Snippet (Safety Valve)	Whether to suppress configuration warnings produced by the Query Server Logging Advanced Configuration Snippet (Safety Valve) configuration validator.		false	`role_config_suppression_log4j_safety_valve`	true
Suppress Configuration Validator: Query Server Log Directory	Whether to suppress configuration warnings produced by the Query Server Log Directory configuration validator.		false	`role_config_suppression_log_dir`	true
Suppress Configuration Validator: Heap Dump Directory	Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator.		false	`role_config_suppression_oom_heap_dump_dir`	true
Suppress Configuration Validator: Query Server Advanced Configuration Snippet (Safety Valve) for phoenix-site.xml	Whether to suppress configuration warnings produced by the Query Server Advanced Configuration Snippet (Safety Valve) for phoenix-site.xml configuration validator.		false	`role_config_suppression_phoenix-site.xml_role_safety_valve`	true
Suppress Configuration Validator: Phoenix Query Server Port	Whether to suppress configuration warnings produced by the Phoenix Query Server Port configuration validator.		false	`role_config_suppression_phoenix_query_server_port`	true
Suppress Configuration Validator: Query Server Environment Advanced Configuration Snippet (Safety Valve)	Whether to suppress configuration warnings produced by the Query Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator.		false	`role_config_suppression_phoenix_query_server_role_env_safety_valve`	true
Suppress Configuration Validator: Role Triggers	Whether to suppress configuration warnings produced by the Role Triggers configuration validator.		false	`role_config_suppression_role_triggers`	true
Suppress Configuration Validator: Stacks Collection Directory	Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator.		false	`role_config_suppression_stacks_collection_directory`	true
Suppress Parameter Validation: Kerberos Principal	Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Principal parameter.		false	`service_config_suppression_kerberos_princ_name`	true
Suppress Configuration Validator: Query Server Count Validator	Whether to suppress configuration warnings produced by the Query Server Count Validator configuration validator.		false	`service_config_suppression_phoenix_query_server_count_validator`	true
Suppress Parameter Validation: Phoenix Service Environment Advanced Configuration Snippet (Safety Valve)	Whether to suppress configuration warnings produced by the built-in parameter validation for the Phoenix Service Environment Advanced Configuration Snippet (Safety Valve) parameter.		false	`service_config_suppression_phoenix_service_env_safety_valve`	true
Suppress Parameter Validation: System Group	Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter.		false	`service_config_suppression_process_groupname`	true
Suppress Parameter Validation: System User	Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter.		false	`service_config_suppression_process_username`	true
Suppress Parameter Validation: Service Triggers	Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter.		false	`service_config_suppression_service_triggers`	true
Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)	Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter.		false	`service_config_suppression_smon_derived_configs_safety_valve`	true
Suppress Health Test: Query Server Health	Whether to suppress the results of the Query Server Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.		false	`service_health_suppression_phoenix_phoenix_query_server_healthy`	true