Phoenix Properties in Cloudera Runtime 7.2.18
Role groups:
Query Server
Advanced
Query Server Logging Advanced Configuration Snippet (Safety Valve)
- Description
- For advanced use only, a string to be inserted into log4j.properties for this role only.
- Related Name
- Default Value
- API Name
-
log4j_safety_valve
- Required
- false
Enable auto refresh for metric configurations
- Description
- When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
- Related Name
- Default Value
- false
- API Name
-
metric_config_auto_refresh
- Required
- false
Heap Dump Directory
- Description
- Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role.
- Related Name
-
oom_heap_dump_dir
- Default Value
- /tmp
- API Name
-
oom_heap_dump_dir
- Required
- false
Dump Heap When Out of Memory
- Description
- When set, generates a heap dump file when when an out-of-memory error occurs.
- Related Name
- Default Value
- 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
Query Server Advanced Configuration Snippet (Safety Valve) for phoenix-site.xml
- Description
- For advanced use only. A string to be inserted into phoenix-site.xml for this role only.
- Related Name
- Default Value
- API Name
-
phoenix-site.xml_role_safety_valve
- Required
- false
Query 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
-
PHOENIX_QUERY_SERVER_role_env_safety_valve
- 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
- false
- API Name
-
process_auto_restart
- Required
- true
Enable Metric Collection
- Description
- Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process.
- Related Name
- Default Value
- true
- API Name
-
process_should_monitor
- Required
- true
Process Start Retry Attempts
- Description
- Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period.
- Related Name
- Default Value
- 3
- API Name
-
process_start_retries
- Required
- false
Process Start Wait Timeout
- Description
- The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature.
- Related Name
- Default Value
- 20
- API Name
-
process_start_secs
- Required
- false
Logs
Query Server Log Directory
- Description
- The log directory for log files of the role Query Server.
- Related Name
-
log_dir
- Default Value
- /var/log/phoenix
- API Name
-
log_dir
- Required
- false
Query Server Logging Threshold
- Description
- The minimum log level for Query Server logs
- Related Name
- Default Value
- INFO
- API Name
-
log_threshold
- Required
- false
Query Server Maximum Log File Backups
- Description
- The maximum number of rolled log files to keep for Query Server logs. Typically used by log4j or logback.
- Related Name
- Default Value
- 10
- API Name
-
max_log_backup_index
- Required
- false
Query Server Max Log Size
- Description
- The maximum size, in megabytes, per log file for Query Server logs. Typically used by log4j or logback.
- Related Name
- Default Value
- 200 MiB
- API Name
-
max_log_size
- Required
- false
Monitoring
Enable Health Alerts for this Role
- Description
- When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
- Related Name
- Default Value
- true
- API Name
-
enable_alerts
- Required
- false
Enable Configuration Change Alerts
- Description
- When set, Cloudera Manager will send alerts when this entity's configuration changes.
- Related Name
- Default Value
- false
- API Name
-
enable_config_alerts
- Required
- false
Enable JMX Exporter (beta)
- Description
- JMX Exporter support is a beta feature. If enabled, CM configures the role to run JMX Exporter in agent mode with the provided port and YAML configuration. This exporter then can be used with the OpenTelemetry Collector feature. See the JMX Exporter documentation.
- Related Name
- Default Value
- false
- API Name
-
jmx_exporter_enabled
- Required
- true
JMX Exporter Port
- Description
- JMX Exporter needs a port to implement a Prometheus exporter.
- Related Name
- Default Value
- API Name
-
jmx_exporter_port
- Required
- false
JMX Exporter configuration YAML
- Description
- This configuration is passed to JMX Exporter as it is. See the JMX Exporter documentation.
- Related Name
- Default Value
- API Name
-
jmx_exporter_yaml
- Required
- false
Log Directory Free Space Monitoring Absolute Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
- Related Name
- Default Value
- Warning: 10 GiB, Critical: 5 GiB
- API Name
-
log_directory_free_space_absolute_thresholds
- Required
- false
Log Directory Free Space Monitoring Percentage Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
log_directory_free_space_percentage_thresholds
- Required
- false
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.
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
{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
- Related Name
- Default Value
- API Name
-
monitoring_metric_filter
- Required
- false
OpenTelemetry Collector Exporters Section
- Description
- Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
- Related Name
- Default Value
- exporters: prometheusremotewrite/$ROLE_NAME: endpoint: $ROLE_PARAM(otelcol_remote_write_url) auth: authenticator: basicauth/common tls: insecure_skip_verify: true retry_on_failure: enabled: true initial_interval: 10s max_interval: 40s max_elapsed_time: 300s
- API Name
-
otelcol_exporters
- Required
- false
OpenTelemetry Collector Extensions Section
- Description
- Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
- Related Name
- Default Value
- extensions: basicauth/common: client_auth: username: $ROLE_PARAM(otelcol_remote_write_user) password: '$ROLE_PARAM(otelcol_remote_write_password)'
- API Name
-
otelcol_extensions
- Required
- false
OpenTelemetry Collector Processors Section
- Description
- Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
- Related Name
- Default Value
- API Name
-
otelcol_processors
- Required
- false
OpenTelemetry Collector Receivers Section
- Description
- Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
- Related Name
- Default Value
- API Name
-
otelcol_receivers
- Required
- false
OpenTelemetry Collector Remote Write Password
- Description
- Remote write password for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_password) expression. Specify $INFRA(cdp_request_signer_password) when forwarding to Cloudera Observability central monitoring. (This is the default.)
- Related Name
- Default Value
- ******
- API Name
-
otelcol_remote_write_password
- Required
- false
OpenTelemetry Collector Remote Write URL
- Description
- Remote write URL for the OpenTelemetry Collector. This param is for convenience and intended to be used at the exporters section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_url) expression. Specify $INFRA(cdp_request_signer_url) when forwarding to Cloudera Observability central monitoring.
- Related Name
- Default Value
- $INFRA(cdp_request_signer_url)
- API Name
-
otelcol_remote_write_url
- Required
- false
OpenTelemetry Collector Remote Write Username
- Description
- Remote write username for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_user) expression. Specify $INFRA(cdp_request_signer_username) when forwarding to Cloudera Observability central monitoring.
- Related Name
- Default Value
- $INFRA(cdp_request_signer_username)
- API Name
-
otelcol_remote_write_user
- Required
- false
OpenTelemetry Collector Service Section
- Description
- Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
- Related Name
- Default Value
- API Name
-
otelcol_service
- Required
- false
Enable OpenTelemetry Collector (beta)
- Description
- OpenTelemetry Collector support is a new beta feature (will change without notice) which can run OpenTelemetry Collector as an agent together with the CM Agent to forward metrics to a Prometheus like storage.
- Related Name
- Default Value
- false
- API Name
-
otelcol_should_collect
- Required
- true
File Descriptor Monitoring Thresholds
- Description
- The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
- Related Name
- Default Value
- Warning: 50.0 %, Critical: 70.0 %
- API Name
-
phoenix_query_server_fd_thresholds
- Required
- false
Query Server Host Health Test
- Description
- When computing the overall Query Server health, consider the host's health.
- Related Name
- Default Value
- true
- API Name
-
phoenix_query_server_host_health_enabled
- Required
- false
Query Server Process Health Test
- Description
- Enables the health test that the Query Server's process state is consistent with the role configuration
- Related Name
- Default Value
- true
- API Name
-
phoenix_query_server_scm_health_enabled
- Required
- false
Swap Memory Usage Rate Thresholds
- Description
- The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
process_swap_memory_rate_thresholds
- Required
- false
Swap Memory Usage Rate Window
- Description
- The period to review when computing unexpected swap memory usage change of the process.
- Related Name
-
common.process.swap_memory_rate_window
- Default Value
- 5 minute(s)
- API Name
-
process_swap_memory_rate_window
- Required
- false
Process Swap Memory Thresholds
- Description
- The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
- Related Name
- Default Value
- Warning: 200 B, Critical: Never
- API Name
-
process_swap_memory_thresholds
- Required
- false
Role Triggers
- Description
- The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
triggerName
(mandatory) - The name of the trigger. This value must be unique for the specific role.triggerExpression
(mandatory) - A tsquery expression representing the trigger.streamThreshold
(optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.enabled
(optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.expressionEditorConfig
(optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
[{"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
Enable Remote User Extractor
- Description
- Boolean which controls if a remote user to impersonate should be extracted from the HTTP request parameter made by that user instead of the HTTP-authenticated user name (which is the default). Required for accessing Phoenix Query Server via Knox.
- Related Name
-
phoenix.queryserver.withRemoteUserExtractor
- Default Value
- true
- API Name
-
phoenix_query_server_with_remote_user_extractor
- Required
- false
Additional Phoenix Query Server Options
- Description
- These arguments are passed as part of the Java command line. Commonly, garbage collection flags or extra debugging flags are passed here.
- Related Name
-
phoenix_queryserver_java_opts
- Default Value
- API Name
-
phoenix_queryserver_java_opts
- Required
- false
Phoenix Query Server Max Heapsize
- Description
- Maximum size for the Phoenix Query Server Java Process heap. Passed to Java -Xmx.
- Related Name
-
phoenix_queryserver_max_heap_size
- Default Value
- 2 GiB
- API Name
-
phoenix_queryserver_max_heap_size
- 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
Phoenix Query Server Port
- Description
- The port Phoenix Query Server will listen on
- Related Name
-
phoenix.queryserver.http.port
- Default Value
- 8765
- API Name
-
phoenix_query_server_port
- Required
- false
Resource Management
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
Query Server 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 Query Server 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
-
phoenix.queryserver.tls.truststore
- Default Value
- API Name
-
ssl_client_truststore_location
- Required
- false
Query Server TLS/SSL Trust Store Password
- Description
- The password for the Query Server 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
-
phoenix.queryserver.tls.truststore.password
- Default Value
- API Name
-
ssl_client_truststore_password
- Required
- false
Enable TLS/SSL for Query Server
- Description
- Encrypt communication between clients and Query Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
- Related Name
-
phoenix.queryserver.tls.enabled
- Default Value
- false
- API Name
-
ssl_enabled
- Required
- false
Query 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 Query Server is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
- Related Name
-
phoenix.queryserver.tls.keystore
- Default Value
- API Name
-
ssl_server_keystore_location
- Required
- false
Query Server TLS/SSL Server Keystore File Password
- Description
- The password for the Query Server keystore file.
- Related Name
-
phoenix.queryserver.tls.keystore.password
- Default Value
- API Name
-
ssl_server_keystore_password
- Required
- false
Stacks Collection
Stacks Collection Data Retention
- Description
- The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
- Related Name
-
stacks_collection_data_retention
- Default Value
- 100 MiB
- API Name
-
stacks_collection_data_retention
- Required
- false
Stacks Collection Directory
- Description
- The directory in which stacks logs are placed. If not set, stacks are logged into a
stacks
subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race. - Related Name
-
stacks_collection_directory
- Default Value
- API Name
-
stacks_collection_directory
- Required
- false
Stacks Collection Enabled
- Description
- Whether or not periodic stacks collection is enabled.
- Related Name
-
stacks_collection_enabled
- Default Value
- false
- API Name
-
stacks_collection_enabled
- Required
- true
Stacks Collection Frequency
- Description
- The frequency with which stacks are collected.
- Related Name
-
stacks_collection_frequency
- Default Value
- 5.0 second(s)
- API Name
-
stacks_collection_frequency
- Required
- false
Stacks Collection Method
- Description
- The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped.
- Related Name
-
stacks_collection_method
- Default Value
- jstack
- API Name
-
stacks_collection_method
- Required
- false
Suppressions
Suppress Configuration Validator: CDH Version Validator
- Description
- Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cdh_version_validator
- Required
- true
Suppress Parameter Validation: JMX Exporter Port
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter Port parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_jmx_exporter_port
- Required
- true
Suppress Parameter Validation: JMX Exporter configuration YAML
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter configuration YAML parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_jmx_exporter_yaml
- Required
- true
Suppress Parameter Validation: Query Server Logging Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Query 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: Query Server Log Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Query Server Log Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_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: OpenTelemetry Collector Exporters Section
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Exporters Section parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_exporters
- Required
- true
Suppress Parameter Validation: OpenTelemetry Collector Extensions Section
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Extensions Section parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_extensions
- Required
- true
Suppress Parameter Validation: OpenTelemetry Collector Processors Section
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Processors Section parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_processors
- Required
- true
Suppress Parameter Validation: OpenTelemetry Collector Receivers Section
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Receivers Section parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_receivers
- Required
- true
Suppress Parameter Validation: OpenTelemetry Collector Remote Write Password
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Password parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_remote_write_password
- Required
- true
Suppress Parameter Validation: OpenTelemetry Collector Remote Write URL
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write URL parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_remote_write_url
- Required
- true
Suppress Parameter Validation: OpenTelemetry Collector Remote Write Username
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Username parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_remote_write_user
- Required
- true
Suppress Parameter Validation: OpenTelemetry Collector Service Section
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Service Section parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_service
- Required
- true
Suppress Parameter Validation: Query Server Advanced Configuration Snippet (Safety Valve) for phoenix-site.xml
- Description
- 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.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_phoenix-site.xml_role_safety_valve
- Required
- true
Suppress Parameter Validation: Phoenix Query Server Port
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Phoenix Query Server Port parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_phoenix_query_server_port
- Required
- true
Suppress Parameter Validation: Query Server Environment Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Query Server Environment Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_phoenix_query_server_role_env_safety_valve
- Required
- true
Suppress Parameter Validation: Additional Phoenix Query Server Options
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Additional Phoenix Query Server Options parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_phoenix_queryserver_java_opts
- 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: Query Server TLS/SSL Trust Store File
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Query Server TLS/SSL Trust Store File parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_client_truststore_location
- Required
- true
Suppress Parameter Validation: Query Server TLS/SSL Trust Store Password
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Query Server TLS/SSL Trust Store Password parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_client_truststore_password
- Required
- true
Suppress Parameter Validation: Query Server TLS/SSL Server Keystore File Location
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Query 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: Query Server TLS/SSL Server Keystore File Password
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Query 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: 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_phoenix_phoenix_query_server_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_phoenix_phoenix_query_server_file_descriptor
- 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_phoenix_phoenix_query_server_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_phoenix_phoenix_query_server_log_directory_free_space
- Required
- true
Suppress Health Test: Otelcol Health
- Description
- Whether to suppress the results of the Otelcol Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_phoenix_phoenix_query_server_otelcol_health
- Required
- true
Suppress Health Test: Process Status
- Description
- Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_phoenix_phoenix_query_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_phoenix_phoenix_query_server_swap_memory_usage
- Required
- true
Suppress Health Test: Swap Memory Usage Rate Beta
- Description
- Whether to suppress the results of the Swap Memory Usage Rate Beta heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_phoenix_phoenix_query_server_swap_memory_usage_rate
- Required
- true
Suppress Health Test: Unexpected Exits
- Description
- Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_phoenix_phoenix_query_server_unexpected_exits
- Required
- true
Service-Wide
Advanced
Phoenix Service Environment Advanced Configuration Snippet (Safety Valve)
- Description
- For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of all roles in this service except client configuration.
- Related Name
- Default Value
- API Name
-
PHOENIX_service_env_safety_valve
- Required
- false
System Group
- Description
- The group that this service's processes should run as.
- Related Name
- Default Value
- phoenix
- API Name
-
process_groupname
- Required
- true
System User
- Description
- The user that this service's processes should run as.
- Related Name
- Default Value
- phoenix
- API Name
-
process_username
- Required
- true
Monitoring
Enable Service Level Health Alerts
- Description
- When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
- Related Name
- Default Value
- true
- API Name
-
enable_alerts
- Required
- false
Enable Configuration Change Alerts
- Description
- When set, Cloudera Manager will send alerts when this entity's configuration changes.
- Related Name
- Default Value
- false
- API Name
-
enable_config_alerts
- Required
- false
Healthy Query Server Monitoring Thresholds
- Description
- 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.
- Related Name
- Default Value
- Warning: 99.0 %, Critical: 90.0 %
- API Name
-
PHOENIX_PHOENIX_QUERY_SERVER_healthy_thresholds
- Required
- false
Service Triggers
- Description
- The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
triggerName
(mandatory) - The name of the trigger. This value must be unique for the specific service.triggerExpression
(mandatory) - A tsquery expression representing the trigger.streamThreshold
(optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.enabled
(optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.expressionEditorConfig
(optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
[{"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. - Related Name
- Default Value
- []
- API Name
-
service_triggers
- Required
- true
Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)
- Description
- For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones.
- Related Name
- Default Value
- API Name
-
smon_derived_configs_safety_valve
- Required
- false
Other
HBase Service
- Description
- Name of the HBase service that this Phoenix service instance depends on
- Related Name
- Default Value
- API Name
-
hbase_service
- Required
- true
HDFS Service
- Description
- Name of the HDFS service that this Phoenix service instance depends on
- Related Name
- Default Value
- API Name
-
hdfs_service
- Required
- true
ZooKeeper Service
- Description
- Name of the ZooKeeper service that this Phoenix service instance depends on
- Related Name
- Default Value
- API Name
-
zookeeper_service
- Required
- true
Security
Kerberos Principal
- Description
- Kerberos principal short name used by all roles of this service.
- Related Name
- Default Value
- phoenix
- API Name
-
kerberos_princ_name
- Required
- true
Suppressions
Suppress Configuration Validator: CDH Version Validator
- Description
- Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cdh_version_validator
- Required
- true
Suppress Configuration Validator: JMX Exporter Port
- Description
- Whether to suppress configuration warnings produced by the JMX Exporter Port configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_jmx_exporter_port
- Required
- true
Suppress Configuration Validator: JMX Exporter configuration YAML
- Description
- Whether to suppress configuration warnings produced by the JMX Exporter configuration YAML configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_jmx_exporter_yaml
- Required
- true
Suppress Configuration Validator: Query Server Logging Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the Query Server Logging Advanced Configuration Snippet (Safety Valve) configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log4j_safety_valve
- Required
- true
Suppress Configuration Validator: Query Server Log Directory
- Description
- Whether to suppress configuration warnings produced by the Query Server Log Directory configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log_dir
- Required
- true
Suppress Configuration Validator: Heap Dump Directory
- Description
- Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_oom_heap_dump_dir
- Required
- true
Suppress Configuration Validator: OpenTelemetry Collector Exporters Section
- Description
- Whether to suppress configuration warnings produced by the OpenTelemetry Collector Exporters Section configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_exporters
- Required
- true
Suppress Configuration Validator: OpenTelemetry Collector Extensions Section
- Description
- Whether to suppress configuration warnings produced by the OpenTelemetry Collector Extensions Section configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_extensions
- Required
- true
Suppress Configuration Validator: OpenTelemetry Collector Processors Section
- Description
- Whether to suppress configuration warnings produced by the OpenTelemetry Collector Processors Section configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_processors
- Required
- true
Suppress Configuration Validator: OpenTelemetry Collector Receivers Section
- Description
- Whether to suppress configuration warnings produced by the OpenTelemetry Collector Receivers Section configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_receivers
- Required
- true
Suppress Configuration Validator: OpenTelemetry Collector Remote Write Password
- Description
- Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write Password configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_remote_write_password
- Required
- true
Suppress Configuration Validator: OpenTelemetry Collector Remote Write URL
- Description
- Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write URL configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_remote_write_url
- Required
- true
Suppress Configuration Validator: OpenTelemetry Collector Remote Write Username
- Description
- Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write Username configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_remote_write_user
- Required
- true
Suppress Configuration Validator: OpenTelemetry Collector Service Section
- Description
- Whether to suppress configuration warnings produced by the OpenTelemetry Collector Service Section configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_otelcol_service
- Required
- true
Suppress Configuration Validator: Query Server Advanced Configuration Snippet (Safety Valve) for phoenix-site.xml
- Description
- Whether to suppress configuration warnings produced by the Query Server Advanced Configuration Snippet (Safety Valve) for phoenix-site.xml configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_phoenix-site.xml_role_safety_valve
- Required
- true
Suppress Configuration Validator: Phoenix Query Server Port
- Description
- Whether to suppress configuration warnings produced by the Phoenix Query Server Port configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_phoenix_query_server_port
- Required
- true
Suppress Configuration Validator: Query Server Environment Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the Query Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_phoenix_query_server_role_env_safety_valve
- Required
- true
Suppress Configuration Validator: Additional Phoenix Query Server Options
- Description
- Whether to suppress configuration warnings produced by the Additional Phoenix Query Server Options configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_phoenix_queryserver_java_opts
- Required
- true
Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings)
- Description
- Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_rm_custom_resources
- Required
- true
Suppress Configuration Validator: Role Triggers
- Description
- Whether to suppress configuration warnings produced by the Role Triggers configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_role_triggers
- Required
- true
Suppress Configuration Validator: Query Server TLS/SSL Trust Store File
- Description
- Whether to suppress configuration warnings produced by the Query Server TLS/SSL Trust Store File configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_client_truststore_location
- Required
- true
Suppress Configuration Validator: Query Server TLS/SSL Trust Store Password
- Description
- Whether to suppress configuration warnings produced by the Query Server TLS/SSL Trust Store Password configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_client_truststore_password
- Required
- true
Suppress Configuration Validator: Query Server TLS/SSL Server Keystore File Location
- Description
- Whether to suppress configuration warnings produced by the Query Server TLS/SSL Server Keystore File Location configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_server_keystore_location
- Required
- true
Suppress Configuration Validator: Query Server TLS/SSL Server Keystore File Password
- Description
- Whether to suppress configuration warnings produced by the Query Server TLS/SSL Server Keystore File Password configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_server_keystore_password
- Required
- true
Suppress Configuration Validator: Stacks Collection Directory
- Description
- Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_stacks_collection_directory
- Required
- true
Suppress Parameter Validation: Kerberos Principal
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Principal parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_kerberos_princ_name
- Required
- true
Suppress Configuration Validator: Phoenix HBase Dependency Write-Ahead Log (WAL) Codec Class Validator
- Description
- Whether to suppress configuration warnings produced by the Phoenix HBase Dependency Write-Ahead Log (WAL) Codec Class Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_phoenix_hbase_regionserver_wal_codec_validator
- Required
- true
Suppress Configuration Validator: Query Server Count Validator
- Description
- Whether to suppress configuration warnings produced by the Query Server Count Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_phoenix_query_server_count_validator
- Required
- true
Suppress Parameter Validation: Phoenix Service Environment Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Phoenix Service Environment Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_phoenix_service_env_safety_valve
- Required
- true
Suppress Parameter Validation: System Group
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_process_groupname
- Required
- true
Suppress Parameter Validation: System User
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_process_username
- Required
- true
Suppress Parameter Validation: Service Triggers
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_service_triggers
- Required
- true
Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_smon_derived_configs_safety_valve
- Required
- true
Suppress Health Test: Query Server Health
- Description
- 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.
- Related Name
- Default Value
- false
- API Name
-
service_health_suppression_phoenix_phoenix_query_server_healthy
- Required
- true