Administering the LogRemover Application

Table 6-1: LogRemover.ini Parameters

Parameter Description Valid Values

[General]

Section label. This section controls how often the application agent processes all rules, how many files the application agent will process before delaying, and how long the application agent will delay after each batch of files has been processed. The label should not be edited.

N/A

PostRuleProcessingDelay

Indicates how long, in minutes, the delay is that will be encountered from the time the current round of rule processing is complete and next round begins.

1 - 1440 minutes

Default = 55

FileBatchSize

Indicates how many files will be processed before the file batch delay is introduced.

1 - 60

Default = 10

FileBatchDelay

Indicates how long, in seconds, to delay before another batch of files is processed.

1 - 60 seconds

Default = 2

[ActiveRules]

Section label. This section lists which Rules Section(s) will be processed by LogRemover. The label should not be edited.

N/A

<Rule>

The name of a rules section that will be processed by LogRemover. Several names may be listed, one per line.

This can be any name you choose.

[<Rule>]

Section label. This section names a rule and allows the administrator to configure which file(s) are moved or deleted, whether to check the file or set of files on a daily or hourly basis, and how long to skip the files before moving or deleting them. It also allows the administrator to specify where files for a given rule should be moved.

Must match a rule name listed under [ActiveRules].

FileList

Informs the application agent which file(s) to process for this rule.

If the application agent cannot expand any environment variable, the rule will be ignored (on the given iteration) and the following message will be written to the $PARMLIB/logs/logfiles/*LogRemover*
Sof file:
"[Rule <Current Rule Name>] Could not expand Environment Vars."

If wildcard characters cannot be expanded, the rule will be ignored and the following message will be written to the $PARMLIB/logs/logfiles/*LogRemover*
Sof file: "[Rule <Current Rule Name>] Could not expand FileList."

If FileList starts with any character other than / or $, then FileList will be prepended with $PARMLIB/ and then processed as if $PARMLIB/FileList were in the ini file. $PARMLIB/FileList is not written to the ini file in these cases. It is only prepended and later expanded in memory.

Valid file name(s) must start with either a backslash (/) or a dollar sign ($) or an alphabetic character. A "." or ".." are not allowed as the first character.

FileList may have wildcard characters or environmental variables embedded within them.

LogRetentionPeriod

Indicates how long in LogRetentionUnits time intervals the file should be ignored. After the file is older than LogRetentionPeriod /LogRetentionUnit (e.g., 5 Day), the file is either deleted or moved based on Action .

If LogRetentionPeriod is set to a negative value, the following message will be written to the $PARMLIB/logs/logfiles/*LogRemover*
Sof file: "[Rule <Current Rule Name>] LogRetentionPeriod is invalid. Set LogRetentionPeriod to either zero (skip rule) or a positive value (process in n LogRetentionUnits )."

0 - 32000

0 = rule is skipped

LogRetentionUnits

Indicates whether the LogRetentionPeriod is based on an hourly or daily basis.

If this field is set to any other value, the following message will be written to the $PARMLIB/logs/logfiles/*LogRemover*
Sof file:
"[Rule <Current Rule Name>] LogRetentionUnits is invalid.

day, Day—Sets retention based on days

hour, Hour—Sets retention based on hours

Action

Indicates whether to delete or move the file. If this field is set to move, the file is moved to the location set in MOVEPATH.

If this field is set to any other value, the following message will be written to the $PARMLIB/logs/logfiles/*LogRemover*Sof logfile: "[Rule <Current Rule Name>] Action is invalid.

move, Move—Moves the current file.

delete, Delete—Deletes the current file.

MovePath

When Action is set to move, indicates location of directory.

If the application agent cannot expand any environment variable, the rule will be ignored (on the given iteration) and the following message will be written to the $PARMLIB/logs/logfiles/*LogRemover*
Sof file:
"[Rule <Current Rule Name>] Could not expand Environment Vars."

Wildcard characters may not be included in the MovePath. If they are included, the files will not to be processed and the following message will be written to the $PARMLIB/logs/logfiles/*LogRemover*
Sof file: "Could NOT Move <Current Filename> No such file or directory."

If MovePath starts with any character other than "." or "/", then MovePath will be prepended with $PARMLIB/ and then processed as if $PARMLIB/MovePath were in the ini file. $PARMLIB/MovePath is not written to the .ini file in these cases. It is only prepended and later expanded in memory.

A file path, starting with either a slash (/), an alphabetic character, or a single period (with nothing following the period), which tells the application agent where to move the file on Actions of Move.

MovePath may have environmental variables embedded within them.

If MovePath is set to a period only, the current file is moved to a file named the same as the current file with the suffix "old."

Parameter	Description	Valid Values
[General]	Section label. This section controls how often the application agent processes all rules, how many files the application agent will process before delaying, and how long the application agent will delay after each batch of files has been processed. The label should not be edited.	N/A
PostRuleProcessingDelay	Indicates how long, in minutes, the delay is that will be encountered from the time the current round of rule processing is complete and next round begins.	1 - 1440 minutes Default = 55
FileBatchSize	Indicates how many files will be processed before the file batch delay is introduced.	1 - 60 Default = 10
FileBatchDelay	Indicates how long, in seconds, to delay before another batch of files is processed.	1 - 60 seconds Default = 2
[ActiveRules]	Section label. This section lists which Rules Section(s) will be processed by LogRemover. The label should not be edited.	N/A
<Rule>	The name of a rules section that will be processed by LogRemover. Several names may be listed, one per line.	This can be any name you choose.
[<Rule>]	Section label. This section names a rule and allows the administrator to configure which file(s) are moved or deleted, whether to check the file or set of files on a daily or hourly basis, and how long to skip the files before moving or deleting them. It also allows the administrator to specify where files for a given rule should be moved.	Must match a rule name listed under [ActiveRules].
FileList	Informs the application agent which file(s) to process for this rule. If the application agent cannot expand any environment variable, the rule will be ignored (on the given iteration) and the following message will be written to the $PARMLIB/logs/logfiles/LogRemover Sof file: "[Rule <Current Rule Name>] Could not expand Environment Vars." If wildcard characters cannot be expanded, the rule will be ignored and the following message will be written to the $PARMLIB/logs/logfiles/LogRemover Sof file: "[Rule <Current Rule Name>] Could not expand FileList." If FileList starts with any character other than / or $, then FileList will be prepended with $PARMLIB/ and then processed as if $PARMLIB/FileList were in the ini file. $PARMLIB/FileList is not written to the ini file in these cases. It is only prepended and later expanded in memory.	Valid file name(s) must start with either a backslash (/) or a dollar sign ($) or an alphabetic character. A "." or ".." are not allowed as the first character. FileList may have wildcard characters or environmental variables embedded within them.
LogRetentionPeriod	Indicates how long in LogRetentionUnits time intervals the file should be ignored. After the file is older than LogRetentionPeriod /LogRetentionUnit (e.g., 5 Day), the file is either deleted or moved based on Action . If LogRetentionPeriod is set to a negative value, the following message will be written to the $PARMLIB/logs/logfiles/LogRemover Sof file: "[Rule <Current Rule Name>] LogRetentionPeriod is invalid. Set LogRetentionPeriod to either zero (skip rule) or a positive value (process in n LogRetentionUnits )."	0 - 32000 0 = rule is skipped
LogRetentionUnits	Indicates whether the LogRetentionPeriod is based on an hourly or daily basis. If this field is set to any other value, the following message will be written to the $PARMLIB/logs/logfiles/LogRemover Sof file: "[Rule <Current Rule Name>] LogRetentionUnits is invalid.	day, Day—Sets retention based on days hour, Hour—Sets retention based on hours
Action	Indicates whether to delete or move the file. If this field is set to move, the file is moved to the location set in MOVEPATH. If this field is set to any other value, the following message will be written to the $PARMLIB/logs/logfiles/LogRemoverSof logfile: "[Rule <Current Rule Name>] Action is invalid.	move, Move—Moves the current file. delete, Delete—Deletes the current file.
MovePath	When Action is set to move, indicates location of directory. If the application agent cannot expand any environment variable, the rule will be ignored (on the given iteration) and the following message will be written to the $PARMLIB/logs/logfiles/LogRemover Sof file: "[Rule <Current Rule Name>] Could not expand Environment Vars." Wildcard characters may not be included in the MovePath. If they are included, the files will not to be processed and the following message will be written to the $PARMLIB/logs/logfiles/LogRemover Sof file: "Could NOT Move <Current Filename> No such file or directory." If MovePath starts with any character other than "." or "/", then MovePath will be prepended with $PARMLIB/ and then processed as if $PARMLIB/MovePath were in the ini file. $PARMLIB/MovePath is not written to the .ini file in these cases. It is only prepended and later expanded in memory.	A file path, starting with either a slash (/), an alphabetic character, or a single period (with nothing following the period), which tells the application agent where to move the file on Actions of Move. MovePath may have environmental variables embedded within them. If MovePath is set to a period only, the current file is moved to a file named the same as the current file with the suffix "old."

Figure 6-1 shows the default contents of the Samples/LogRemover.ini configuration file.

Figure 6-1: Example of a LogRemover.ini File

[General] PostRuleProcessingDelay=55 FileBatchSize=10 FileBatchDelay=2 [ActiveRules] AllStdErrOutOut AllStdErrOutErr AllEventLogs AllResLogs AllSofLogs AllSNMPLog AllSNMPErr APPStdErrOutOut APPStdErrOutErr TNTStdErrOutOut TNTStdErrOutErr UMStdErrOutOut UMStdErrOutErr AllUMSofLogs AllEscalation [AllStdErrOutOut] FileList=logs/stderrout/*out LogRetentionPeriod=3 LogRetentionUnits=Day Action=Delete MovePath=. [AllStdErrOutErr] FileList=logs/stderrout/*err LogRetentionPeriod=3 LogRetentionUnits=Day Action=Delete MovePath=. [AllEventLogs] FileList=logs/logfiles/*.Eve LogRetentionPeriod=2 LogRetentionUnits=Day Action=Delete MovePath=. [AllResLogs] FileList=logs/logfiles/*.Res LogRetentionPeriod=2 LogRetentionUnits=Day Action=Delete MovePath=. [AllSofLogs] FileList=logs/logfiles/*.Sof LogRetentionPeriod=2 LogRetentionUnits=Day Action=Delete MovePath=. [AllSNMPLog] FileList=logs/logfiles/*snmp*.log LogRetentionPeriod=2 LogRetentionUnits=Day Action=Delete MovePath=.
[AllSNMPErr] FileList=logs/stderrout/*snmp*.err LogRetentionPeriod=2 LogRetentionUnits=Day Action=Delete MovePath=. [APPStdErrOutOut] FileList=logs/stderrout/APP*out* LogRetentionPeriod=1 LogRetentionUnits=Day Action=Delete MovePath=. [APPStdErrOutErr] FileList=logs/stderrout/APP*err* LogRetentionPeriod=1 LogRetentionUnits=Day Action=Delete MovePath=. [TNTStdErrOutOut] FileList=logs/stderrout/TNT*out LogRetentionPeriod=1 LogRetentionUnits=Day Action=Delete MovePath=. [TNTStdErrOutErr] FileList=logs/stderrout/TNT*err LogRetentionPeriod=1 LogRetentionUnits=Day Action=Delete MovePath=. [UMStdErrOutOut] FileList=logs/stderrout/UM*out LogRetentionPeriod=2 LogRetentionUnits=Hour Action=Delete MovePath=. [UMStdErrOutErr] FileList=logs/stderrout/UM*err LogRetentionPeriod=2 LogRetentionUnits=Hour Action=Delete MovePath=. [AllUMSofLogs] FileList=logs/logfiles/*UM*.Sof LogRetentionPeriod=2 LogRetentionUnits=Hour Action=Delete MovePath=. [AllEscalation] FileList=logs/escalation/* LogRetentionPeriod=2 LogRetentionUnits=Hour Action=Delete MovePath=.

[General] PostRuleProcessingDelay=55 FileBatchSize=10 FileBatchDelay=2 [ActiveRules] AllStdErrOutOut AllStdErrOutErr AllEventLogs AllResLogs AllSofLogs AllSNMPLog AllSNMPErr APPStdErrOutOut APPStdErrOutErr TNTStdErrOutOut TNTStdErrOutErr UMStdErrOutOut UMStdErrOutErr AllUMSofLogs AllEscalation [AllStdErrOutOut] FileList=logs/stderrout/out LogRetentionPeriod=3 LogRetentionUnits=Day Action=Delete MovePath=. [AllStdErrOutErr] FileList=logs/stderrout/err LogRetentionPeriod=3 LogRetentionUnits=Day Action=Delete MovePath=. [AllEventLogs] FileList=logs/logfiles/.Eve LogRetentionPeriod=2 LogRetentionUnits=Day Action=Delete MovePath=. [AllResLogs] FileList=logs/logfiles/.Res LogRetentionPeriod=2 LogRetentionUnits=Day Action=Delete MovePath=. [AllSofLogs] FileList=logs/logfiles/.Sof LogRetentionPeriod=2 LogRetentionUnits=Day Action=Delete MovePath=. [AllSNMPLog] FileList=logs/logfiles/snmp*.log LogRetentionPeriod=2 LogRetentionUnits=Day Action=Delete MovePath=.	[AllSNMPErr] FileList=logs/stderrout/snmp.err LogRetentionPeriod=2 LogRetentionUnits=Day Action=Delete MovePath=. [APPStdErrOutOut] FileList=logs/stderrout/APPout LogRetentionPeriod=1 LogRetentionUnits=Day Action=Delete MovePath=. [APPStdErrOutErr] FileList=logs/stderrout/APPerr LogRetentionPeriod=1 LogRetentionUnits=Day Action=Delete MovePath=. [TNTStdErrOutOut] FileList=logs/stderrout/TNTout LogRetentionPeriod=1 LogRetentionUnits=Day Action=Delete MovePath=. [TNTStdErrOutErr] FileList=logs/stderrout/TNTerr LogRetentionPeriod=1 LogRetentionUnits=Day Action=Delete MovePath=. [UMStdErrOutOut] FileList=logs/stderrout/UMout LogRetentionPeriod=2 LogRetentionUnits=Hour Action=Delete MovePath=. [UMStdErrOutErr] FileList=logs/stderrout/UMerr LogRetentionPeriod=2 LogRetentionUnits=Hour Action=Delete MovePath=. [AllUMSofLogs] FileList=logs/logfiles/UM.Sof LogRetentionPeriod=2 LogRetentionUnits=Hour Action=Delete MovePath=. [AllEscalation] FileList=logs/escalation/* LogRetentionPeriod=2 LogRetentionUnits=Hour Action=Delete MovePath=.