Sqoop 2 Properties in CDH 5.7.0
Role groups:
Service-Wide
Advanced
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
System Group | The group that this service's processes should run as. | sqoop | process_groupname | true | |
System User | The user that this service's processes should run as. | sqoop2 | process_username | true | |
Sqoop 2 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. | sqoop_env_safety_valve | false |
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 | |
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:
|
[] | 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 | ||
Sqoop 2 Server Role Health Test | When computing the overall SQOOP health, consider Sqoop 2 Server's health | true | sqoop_sqoop_server_health_enabled | false |
Other
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
MapReduce Service | MapReduce jobs are run against this service. | mapreduce_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. | sqoop2 | kerberos_princ_name | true |
Suppressions
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
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: 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 Configuration Validator: Sqoop2 Deprecation Validator | Whether to suppress configuration warnings produced by the Sqoop2 Deprecation Validator configuration validator. | false | service_config_suppression_sqoop_deprecation_validator | true | |
Suppress Parameter Validation: Sqoop 2 Service Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Sqoop 2 Service Environment Advanced Configuration Snippet (Safety Valve) parameter. | false | service_config_suppression_sqoop_env_safety_valve | true | |
Suppress Configuration Validator: Sqoop 2 Server Count Validator | Whether to suppress configuration warnings produced by the Sqoop 2 Server Count Validator configuration validator. | false | service_config_suppression_sqoop_server_count_validator | true | |
Suppress Health Test: Sqoop 2 Server Health | Whether to suppress the results of the Sqoop 2 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_sqoop_sqoop_server_health | true |
Sqoop 2 Server
Advanced
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Sqoop 2 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 | |
Sqoop 2 Server Advanced Configuration Snippet (Safety Valve) for sqoop.properties | For advanced use only. A string to be inserted into sqoop.properties for this role only. | sqoop_config_safety_valve | false | ||
Java Configuration Options for Sqoop 2 Server | These arguments will be passed as part of the Java command line. Commonly, garbage collection flags, PermGen, or extra debugging flags would be passed here. | sqoop_java_opts | false | ||
Sqoop 2 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. | SQOOP_SERVER_role_env_safety_valve | false |
Database
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Sqoop 2 Server Metastore Directory | Directory where the Sqoop 2 Server places its metastore data. This is used only when Sqoop Repository Database Type is Derby. | /var/lib/sqoop2 | sqoop_metastore_data_dir | false | |
Sqoop Repository Database Host | Host name of Sqoop repository database. If the port is non-default for your database type, use host:port notation. Does not apply if you are using Derby as the database type. | localhost | sqoop_repository_database_host | false | |
Sqoop Repository Database Name | Name of Sqoop repository database. Does not apply if you are using Derby as the database type. | sqoop | sqoop_repository_database_name | false | |
Sqoop Repository Database Password | Password for Sqoop repository database. Does not apply if you are using Derby as the database type. | org.apache.sqoop.repository.jdbc.password | sqoop_repository_database_password | false | |
Sqoop Repository Database Type | Type of Sqoop repository database. | derby | sqoop_repository_database_type | false | |
Sqoop Repository Database User | User for Sqoop repository database. Does not apply if you are using Derby as the database type. | org.apache.sqoop.repository.jdbc.user | sa | sqoop_repository_database_user | false |
Logs
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Sqoop 2 Server Logging Threshold | The minimum log level for Sqoop 2 Server logs | INFO | log_threshold | false | |
Sqoop 2 Server Maximum Log File Backups | The maximum number of rolled log files to keep for Sqoop 2 Server logs. Typically used by log4j or logback. | 10 | max_log_backup_index | false | |
Sqoop 2 Server Max Log Size | The maximum size, in megabytes, per log file for Sqoop 2 Server logs. Typically used by log4j or logback. | 200 MiB | max_log_size | false | |
Sqoop 2 Server Log Directory | Directory where Sqoop 2 Server will place its log files. | /var/log/sqoop2 | sqoop_log_dir | 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 | |
Heap Dump Directory Free Space Monitoring Absolute Thresholds | The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory. | Warning: 10 GiB, Critical: 5 GiB | heap_dump_directory_free_space_absolute_thresholds | false | |
Heap Dump Directory Free Space Monitoring Percentage Thresholds | The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Heap Dump Directory Free Space Monitoring Absolute Thresholds setting is configured. | Warning: Never, Critical: Never | heap_dump_directory_free_space_percentage_thresholds | 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. | Warning: Any, 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:
|
[] | role_triggers | true | |
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 % | sqoop_server_fd_thresholds | false | |
Sqoop 2 Server Host Health Test | When computing the overall Sqoop 2 Server health, consider the host's health. | true | sqoop_server_host_health_enabled | false | |
Sqoop 2 Server Process Health Test | Enables the health test that the Sqoop 2 Server's process state is consistent with the role configuration | true | sqoop_server_scm_health_enabled | false | |
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 Client Connections | Maximum number of clients allowed to connect to the Sqoop 2 Server. | org.apache.sqoop.repository.jdbc.maximum.connections | 10 | max_client_connections | false |
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 |
---|---|---|---|---|---|
Sqoop 2 Admin Port | Admin port of Sqoop 2 Server. (Note: This configuration only applies from CDH 4.3 onwards.) | 8005 | sqoop_admin_port | true | |
Sqoop 2 HTTP Port | HTTP port of Sqoop 2 Server. (Note: This configuration only applies from CDH 4.3 onwards.) | 12000 | sqoop_http_port | true |
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 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. | 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 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. | memory.soft_limit_in_bytes | -1 MiB | rm_memory_soft_limit | true |
Java Heap Size of Sqoop 2 Server in Bytes | Maximum size in bytes for the Java Process heap memory. Passed to Java -Xmx. | 1 GiB | sqoop_java_heapsize | 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: 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: Sqoop 2 Server Logging Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Sqoop 2 Server Logging Advanced Configuration Snippet (Safety Valve) parameter. | false | role_config_suppression_log4j_safety_valve | 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: Sqoop 2 Server Advanced Configuration Snippet (Safety Valve) for sqoop.properties | Whether to suppress configuration warnings produced by the built-in parameter validation for the Sqoop 2 Server Advanced Configuration Snippet (Safety Valve) for sqoop.properties parameter. | false | role_config_suppression_sqoop_config_safety_valve | true | |
Suppress Parameter Validation: Java Configuration Options for Sqoop 2 Server | Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Configuration Options for Sqoop 2 Server parameter. | false | role_config_suppression_sqoop_java_opts | true | |
Suppress Parameter Validation: Sqoop 2 Server Log Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Sqoop 2 Server Log Directory parameter. | false | role_config_suppression_sqoop_log_dir | true | |
Suppress Parameter Validation: Sqoop 2 Server Metastore Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Sqoop 2 Server Metastore Directory parameter. | false | role_config_suppression_sqoop_metastore_data_dir | true | |
Suppress Parameter Validation: Sqoop Repository Database Host | Whether to suppress configuration warnings produced by the built-in parameter validation for the Sqoop Repository Database Host parameter. | false | role_config_suppression_sqoop_repository_database_host | true | |
Suppress Parameter Validation: Sqoop Repository Database Name | Whether to suppress configuration warnings produced by the built-in parameter validation for the Sqoop Repository Database Name parameter. | false | role_config_suppression_sqoop_repository_database_name | true | |
Suppress Parameter Validation: Sqoop Repository Database Password | Whether to suppress configuration warnings produced by the built-in parameter validation for the Sqoop Repository Database Password parameter. | false | role_config_suppression_sqoop_repository_database_password | true | |
Suppress Parameter Validation: Sqoop Repository Database User | Whether to suppress configuration warnings produced by the built-in parameter validation for the Sqoop Repository Database User parameter. | false | role_config_suppression_sqoop_repository_database_user | true | |
Suppress Parameter Validation: Sqoop 2 Server Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Sqoop 2 Server Environment Advanced Configuration Snippet (Safety Valve) parameter. | false | role_config_suppression_sqoop_server_role_env_safety_valve | 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_sqoop_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_sqoop_server_file_descriptor | true | |
Suppress Health Test: Heap Dump Directory Free Space | Whether to suppress the results of the Heap Dump Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false | role_health_suppression_sqoop_server_heap_dump_directory_free_space | 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_sqoop_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_sqoop_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_sqoop_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_sqoop_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_sqoop_server_unexpected_exits | true |