The agent.properties File - Teradata Data Mover

Teradata Data Mover Installation, Configuration, and Upgrade Guide for Customers

Product
Teradata Data Mover
Release Number
16.00
Published
December 2016
Language
English (United States)
Last Update
2018-03-29
dita:mapPath
fsa1467305282096.ditamap
dita:ditavalPath
ft:empty
dita:id
B035-4102
Product Category
Analytical Ecosystem
The following table shows the properties in agent.properties.
Property Description Default Value
agent.id=id Unique identifier for this agent. Agent1
arc.port=port number Port number that can be used by Teradata ARC to manage ARC streams. 25268
cluster.enabled= setting for cluster When set to True, establishes a connection to a secondary Java Message Service (JMS) broker in case the primary JMS broker fails. False
broker.port=port number The port number of the machine where the Java Message Service (JMS) Message Broker is listening. 61616
broker.url=url The hostname or IP address of the machine running the Java Message Service (JMS) Message Broker. localhost
log4j.appender.logfile=org.apache.log4j.RollingFileAppender Informs the logging application to use a specific appender.

It is recommended that this property value not be changed.

 
log4j.appender.logfile.file=log file path Relative or absolute path of the log file. If changing log file location, specify the absolute path of the file. For Windows, specify back slash instead of forward slash, for example, C:\ProgramFile\Teradata\Log\dmAgent.log.

Both file path and file name can be set dynamically.1

dmAgent.log
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout Dynamic property. 1
Do not edit. This is an internal setting for logging infrastructure.
 
log4j.appender.logfile.maxBackupIndex=number of backup logging files The number of backup logging files that are created. After the maximum number of files has been created, the oldest file is erased. Dynamic property. 1

Example

If Max Backups = 3, three backup logs are created:
  • dmAgent.log.1
  • dmAgent.log.2
  • dmAgent.log.3
If the current dmAgent.log size exceeds 10MB, it rolls to become the new dmAgent.log.1 and a new dmAgent.log is created. The previous dmAgent.log.2 becomes the new dmAgent.log.3. The previous dmAgent.log.3 is deleted.
3
log4j.appender.logfile.maxFileSize=maximum size of log files The maximum size of the logging file before being rolled over to backup files. Dynamic property. 1 10MB
log4j.appender.logfile.layout.ConversionPattern=log file pattern layout The pattern of the log file layout, where:
  • d = date
  • t = thread
  • p = log level
  • c = class name
  • m= message
  • n = platform dependent line separator
Dynamic property. 1 Information for creating a layout is at: http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/PatternLayout.html
%d [%t] %-5p %c{3} - %m%n
log4j.rootLogger=level of logging 6 levels of logging, TRACE | DEBUG | INFO | WARN | ERROR | FATAL. From trace level to application error. LOG_LEVEL can be updated dynamically, but not logfile.1

Value is:

LOG_LEVEL, logfile

Do not remove the term logfile.
INFO,logfile
agent.maxConcurrentTasks=maximum number of tasks The maximum number of tasks allowed to run on this agent at the same time.

Note that tasks are distributed to agents using a round robin method. Task size is not currently considered, so load may not be balanced if one agent is randomly assigned larger tasks than another.

5
logger.useTviLogger=setting for TVI messages The TVI logger can be set to true or false. If set to true, fatal error messages are sent to TVI. Dynamic property. 1 True

1Dynamic Properties

For properties that can be set dynamically, the changes take effect one minute after the updated daemon.properties file is saved. There is no need to restart the daemon service if you are only updating dynamic properties. For example:
  • If you changed the value of log4j.rootLogger from the default of INFO, logfile to DEBUG, logfile, any debug messages generated would start appearing in the log file one minute after saving the updated properties file.
  • If you changed the value of agent.maxConcurrentTasks from the default value of 5 to a new value of 6, the new value of 6 would take effect one minute after saving the updated agent.properties file.