User Guide
Also available as:
PDF

HST Agent

The following configuration properties are available for HST Agent:

Table 3.3. HST Agent Configuration Properties

Property NameDescriptionWhere to ConfigureGuidelines

agent.tmp_dir

Temporary directory used by agents to keep local bundles during bundle preparation.

Type: string

Default Value: /var/lib/smartsense/hst-agent/data/tmp

Ambari Config:

Basic

Config File:

/etc/hst/conf/hst-agent.ini

You must have at least 10GB of free space in this directory.

This should be set to a different location than the server tmp directory.

security.anonymization.max.heap

The maximum heap allocated (in MB) on every agent for anonymization.

Type: int

Default Value: 2048

Ambari Config:

Advanced > Custom hst-agent-conf

Config File:

/etc/hst/conf/hst-agent.ini

If you experience out of memory exceptions during the anonymization process, increase the heap size gradually depending on availability.

agent.loglevel

Provides ability to change the hst-agent logging level. Possible values are: INFO, DEBUG, WARNING, ERROR, CRITICAL.

Type: string

Default Value: INFO

Ambari Config:

Advanced > Custom hst-agent-conf

Config File:

/etc/hst/conf/hst-agent.ini

To debug issues on the agent, set this to DEBUG.

bundle.logs_to_capture

Patterns of log files to be captured.

Type: string

Default Value: (.*).log$,(.*).out$

Ambari Config:

Data Capture

Config File:

/etc/hst/conf/hst-agent.ini

Be careful when capturing more log files as they may turn out to be large and require extra space on the HST server.

server.url_port

Port for one-way SSL communication between HST server and HST agents. This port is usually required during two-way SSL setup.

Type:

Default Value: 9440

Ambari Config:

Advanced > Custom hst-agent-conf

Config File:

/etc/hst/conf/hst-agent.ini

This should be modified in sync with similar property in HST server configurations.

server.secured_url_port

Port for two-way SSL communication between HST server and HST agents.

Type:

Default Value: 9441

Ambari Config:

Advanced > Custom hst-agent-conf

Config File:

/etc/hst/conf/hst-agent.ini

This should be modified in sync with similar property in HST server configurations.

server.two_way_ssl

Enables two-way SSL for communication between HST server and HST agents.

Type: boolean

Default Value: true

Ambari Config:

Advanced > Custom hst-agent-conf

Config File:

/etc/hst/conf/hst-agent.ini

We recommend not to change this unless you have a very specific requirement.

server.connection_retry_count

Number of times to retry to connect to server in case of connection failures and timeouts.

Type: int

Default Value: 100

Ambari Config:

Operations

Config File:

/etc/hst/conf/hst-agent.ini

In many cases, the default value (100 retry attempts) is often more than needed. Reduce it if retry connection attempts are keeping the system busy.

server.connection_retry_interval

Defines the interval (in seconds) between retries.

Type: int

Default Value: 10

Ambari Config:

Operations

Config File:

/etc/hst/conf/hst-agent.ini

Default value is suitable for all clusters.

java.home

Path to the JAVA home for HST agents.

Type: string

Default Value: (no value)

Ambari Config:

Advanced > Custom hst-agent-conf

Config File:

/etc/hst/conf/hst-agent.ini

This setting is automatically configured from Ambari env settings and usually there is no reason to change it.

We recommend that you use the latest 1.7/1.8 JAVA versions with up-to-date security updates. For more security we also recommend that you have unlimited JCE policy installed.

command.heartbeat_interval

The heartbeat interval (in seconds). During agent capture, this heartbeat helps ensure connectivity with HST server and executes certain commands such as cancel capture.

Type: int

Default Value: 30

Ambari Config:

Advanced > Custom hst-agent-conf

Config File:

/etc/hst/conf/hst-agent.ini

Do not change this unless you experience performance issues.

command.check_commands_retry_count

Number of times to retry check commands.

Type: int

Default Value: 10

Ambari Config:

Advanced > Custom hst-agent-conf

Config File:

/etc/hst/conf/hst-agent.ini

Default value is suitable for all clusters.

command.check_commands_retry_interval

Interval (in seconds) between retries for check commands.

Type: int

Default Value: 10

Ambari Config:

Advanced > Custom hst-agent-conf

Config File:

/etc/hst/conf/hst-agent.ini

Default value is suitable for all clusters.

management.updates.dir

Directory to store updates received from HST server.

Type: string

Default Value: /var/lib/smartsense/hst-agent/updates

Ambari Config:

Advanced > Custom hst-agent-conf

Config File:

/etc/hst/conf/hst-agent.ini

We recommend not to change this unless you have a very specific requirement. If changing this, verify that permissions are set accordingly.

management.patch.auto.apply.enabled

Enable automatically downloading and applying updates received from HST server.

Type: boolean

Default Value: true

Ambari Config:

Advanced > Custom hst-agent-conf

Config File:

/etc/hst/conf/hst-agent.ini

Disable only if you do not want the HST server to propagate the agent configuration changes to all agents.

bundle.compress_captured_log_locally

By default this is set to false; i.e the log files are included as they are, without applying compression.

Type: boolean

Default Value: false

Ambari Config:

Advanced > Custom hst-agent-conf

Config File:

/etc/hst/conf/hst-agent.ini

If capture requests are timing out, set this to true to activate log compression. Note that the compressed files will not be anonymized.

upload.retry_count

Number of times the agent will retry to submit its local bundle to server. Note that this is different from uploading the final bundle to Hortonworks.

Type: int

Default Value: 100

Ambari Config:

Operations

Config File:

/etc/hst/conf/hst-agent.ini

Default value is suitable for all clusters.
upload.min_retry_interval

Minimum interval (in seconds) between bundle upload retries made by agents. Random value between min_retry_interval and max_retry_interval will be used. For constant value, use retry_interval=x.

Type: int

Default Value: 15

Ambari Config:

Operations

Config File:

/etc/hst/conf/hst-agent.ini

Default value is suitable for all clusters.

upload.max_retry_interval

Maximum interval (in seconds) between bundle upload retries made by agents. Random value between min_retry_interval and max_retry_interval will be used. For constant value, use retry_interval=x.

Type: int

Default Value: 120

Ambari Config:

Operations

Config File:

/etc/hst/conf/hst-agent.ini

Default value is suitable for all clusters.

handler.largefiles.size

Minimum file size (in MB) for a file to qualify as a large file. Large files are handled based on action defined in the `handler.largefiles.action` property.

Type: int

Default Value: 512

Ambari Config:

Advanced > Custom hst-agent-conf

Config File:

/etc/hst/conf/hst-agent.ini

Update this if you have a specific requirement which includes capturing files larger than 512 MB.

handler.largefiles.action

Action to handle a large file. Supported actions are 'allow', 'ignore', 'truncate', 'fail'.

Type: string

Default Value: truncate

Ambari Config:

Advanced > Custom hst-agent-conf

Config File:

/etc/hst/conf/hst-agent.ini

Configure action to handle large files based on your requirements.