Livy Properties in Cloudera Runtime 7.0.x

Categories:

Advanced🔗

Display Name	Description	Related Name	Default Value	API Name	Required
Deploy Directory	The directory where the client configs will be deployed		/etc/livy	client_config_root_dir	true
Livy Client Advanced Configuration Snippet (Safety Valve) for livy-conf/livy-client.conf	For advanced use only, a string to be inserted into the client configuration for livy-conf/livy-client.conf.			livy-conf/livy-client.conf_client_config_safety_valve	false

Monitoring🔗

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

Other🔗

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

Suppressions🔗

Display Name	Description	Related Name	Default Value	API Name	Required
Suppress Configuration Validator: Version Validator	Whether to suppress configuration warnings produced by the Version Validator configuration validator.		false	role_config_suppression_cdh_version_validator	true
Suppress Parameter Validation: Deploy Directory	Whether to suppress configuration warnings produced by the built-in parameter validation for the Deploy Directory parameter.		false	role_config_suppression_client_config_root_dir	true
Suppress Parameter Validation: Livy Client Advanced Configuration Snippet (Safety Valve) for livy-conf/livy-client.conf	Whether to suppress configuration warnings produced by the built-in parameter validation for the Livy Client Advanced Configuration Snippet (Safety Valve) for livy-conf/livy-client.conf parameter.		false	role_config_suppression_livy-conf/livy-client.conf_client_config_safety_valve	true

Categories:

Advanced🔗

Display Name	Description	Related Name	Default Value	API Name	Required
Livy Server Advanced Configuration Snippet (Safety Valve) for livy-conf/livy.conf	For advanced use only. A string to be inserted into livy-conf/livy.conf for this role only.			livy-conf/livy.conf_role_safety_valve	false
Livy 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.			LIVY_SERVER_role_env_safety_valve	false
Livy 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
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
Livy Server Log Directory	The log directory for log files of the role Livy Server.	log_dir	/var/log/livy	log_dir	false
Livy Server Logging Threshold	The minimum log level for Livy Server logs		INFO	log_threshold	false
Livy Server Maximum Log File Backups	The maximum number of rolled log files to keep for Livy Server logs. Typically used by log4j or logback.		10	max_log_backup_index	false
Livy Server Max Log Size	The maximum size, in megabytes, per log file for Livy 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
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 %	livy_server_fd_thresholds	false
Livy Server Host Health Test	When computing the overall Livy Server health, consider the host's health.		true	livy_server_host_health_enabled	false
Livy Server Process Health Test	Enables the health test that the Livy Server's process state is consistent with the role configuration		true	livy_server_scm_health_enabled	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
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

Other🔗

Display Name	Description	Related Name	Default Value	API Name	Required
Enable Access Control	Perform access control when processing user requests.	livy.server.access-control.enabled	true	livy_access_control_enabled	false
Admin Users	List of users with admin permissions (can view and modify any session).	livy.superusers	knox zeppelin	livy_admin_users	false
Extra JVM Options	Command line options to add to the Livy Server JVM. May be used also to override options automatically added by CM.	livy_extra_java_opts		livy_extra_java_opts	false
Enable User Impersonation	Start applications as the requesting user, instead of using the Livy account.	livy.impersonation.enabled	true	livy_impersonation_enabled	false
Max Header Size	Maximum size of a header field accepted by the Livy server. May need to be increased in certain environments where SPNEGO is enabled.	livy.server.request-header.size	128 KiB	livy_max_header_size	false
Java Heap Size of Livy Server	Maximum size for the Java process heap memory.	livy_max_heapsize	512 MiB	livy_max_heapsize	false
Enable RPC Encryption	Enable encryption of communication between the Livy session and managed Spark sessions.	livy_rpc_encryption_enabled	true	livy_rpc_encryption_enabled	false
Enable Session Recovery	Enable recovery of live sessions when the Livy server restarts. Uses HDFS to store recovery information.	livy_session_recovery_enabled	true	livy_session_recovery_enabled	false
Enable User Authentication	Enables user authentication using SPNEGO when Kerberos is enabled.	livy_spnego_enabled	true	livy_spnego_enabled	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
Livy Server Port	The port of the Livy server	livy.server.port	8998	livy_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

Security🔗

Display Name	Description	Related Name	Default Value	API Name	Required
Enable TLS/SSL for Livy Server	Encrypt communication between clients and Livy Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).	livy.tls.enabled	false	ssl_enabled	false
Livy Server TLS/SSL Server JKS Keystore File Location	The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Livy Server is acting as a TLS/SSL server. The keystore must be in JKS format.	livy.keystore		ssl_server_keystore_location	false
Livy Server TLS/SSL Server JKS Keystore File Password	The password for the Livy Server JKS keystore file.	livy.keystore.password		ssl_server_keystore_password	false

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: Version Validator	Whether to suppress configuration warnings produced by the Version Validator configuration validator.		false	role_config_suppression_cdh_version_validator	true
Suppress Parameter Validation: Livy Server Advanced Configuration Snippet (Safety Valve) for livy-conf/livy.conf	Whether to suppress configuration warnings produced by the built-in parameter validation for the Livy Server Advanced Configuration Snippet (Safety Valve) for livy-conf/livy.conf parameter.		false	role_config_suppression_livy-conf/livy.conf_role_safety_valve	true
Suppress Parameter Validation: Admin Users	Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin Users parameter.		false	role_config_suppression_livy_admin_users	true
Suppress Parameter Validation: Extra JVM Options	Whether to suppress configuration warnings produced by the built-in parameter validation for the Extra JVM Options parameter.		false	role_config_suppression_livy_extra_java_opts	true
Suppress Parameter Validation: Livy Server Port	Whether to suppress configuration warnings produced by the built-in parameter validation for the Livy Server Port parameter.		false	role_config_suppression_livy_server_port	true
Suppress Parameter Validation: Livy Server Environment Advanced Configuration Snippet (Safety Valve)	Whether to suppress configuration warnings produced by the built-in parameter validation for the Livy Server Environment Advanced Configuration Snippet (Safety Valve) parameter.		false	role_config_suppression_livy_server_role_env_safety_valve	true
Suppress Parameter Validation: Livy Server Logging Advanced Configuration Snippet (Safety Valve)	Whether to suppress configuration warnings produced by the built-in parameter validation for the Livy Server Logging Advanced Configuration Snippet (Safety Valve) parameter.		false	role_config_suppression_log4j_safety_valve	true
Suppress Parameter Validation: Livy Server Log Directory	Whether to suppress configuration warnings produced by the built-in parameter validation for the Livy 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: 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: Livy Server TLS/SSL Server JKS Keystore File Location	Whether to suppress configuration warnings produced by the built-in parameter validation for the Livy Server TLS/SSL Server JKS Keystore File Location parameter.		false	role_config_suppression_ssl_server_keystore_location	true
Suppress Parameter Validation: Livy Server TLS/SSL Server JKS Keystore File Password	Whether to suppress configuration warnings produced by the built-in parameter validation for the Livy Server TLS/SSL Server JKS Keystore File Password parameter.		false	role_config_suppression_ssl_server_keystore_password	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_livy_livy_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_livy_livy_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_livy_livy_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_livy_livy_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_livy_livy_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_livy_livy_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_livy_livy_server_unexpected_exits	true

Categories:

Advanced🔗

Display Name	Description	Related Name	Default Value	API Name	Required
Livy 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.			LIVY_service_env_safety_valve	false
System Group	The group that this service's processes should run as.		livy	process_groupname	true
System User	The user that this service's processes should run as.		livy	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
Livy Server Role Health Test	When computing the overall LIVY health, consider Livy Server's health		true	LIVY_LIVY_SERVER_health_enabled	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 followig 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
HMS Service	Name of the HMS service that this Livy service instance depends on			hms_service	false
Recovery Directory (HDFS)	Location where to store recovery metadata.	livy.server.recovery.state-store.url	/user/livy/recovery	livy_recovery_dir	false
SPARK_ON_YARN Service	Name of the SPARK_ON_YARN service that this Livy service instance depends on			spark_on_yarn_service	true
YARN Service	Name of the YARN service that this Livy service instance depends on			yarn_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.		livy	kerberos_princ_name	true

Suppressions🔗

Display Name	Description	Related Name	Default Value	API Name	Required
Suppress Configuration Validator: Gateway Count Validator	Whether to suppress configuration warnings produced by the Gateway Count Validator configuration validator.		false	service_config_suppression_gateway_count_validator	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 Parameter Validation: Recovery Directory (HDFS)	Whether to suppress configuration warnings produced by the built-in parameter validation for the Recovery Directory (HDFS) parameter.		false	service_config_suppression_livy_recovery_dir	true
Suppress Configuration Validator: Livy Server Count Validator	Whether to suppress configuration warnings produced by the Livy Server Count Validator configuration validator.		false	service_config_suppression_livy_server_count_validator	true
Suppress Parameter Validation: Livy Service Environment Advanced Configuration Snippet (Safety Valve)	Whether to suppress configuration warnings produced by the built-in parameter validation for the Livy Service Environment Advanced Configuration Snippet (Safety Valve) parameter.		false	service_config_suppression_livy_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: Livy Server Health	Whether to suppress the results of the Livy 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_livy_livy_livy_server_health	true