Folder

The Folder Monitor monitors a directory. This Monitor comes handy when an application actively uses directories for its operations. The Folder Monitor measures the directory size, growth and flow to:

  • ensure that the application is not overloaded (e.g.: number of files to be processed)
  • measure the application activity (how many files have been removed, that is, how many have been processed)
  • check the age of the newest file to know whether the data is coming in properly
  • check the age of the oldest file to know whether the application is running late in processing queued files.

You can use the %{TIME:<date-time-format>} macro in the Folder Path to dynamically assign the current date or time in the folder name. Refer to Date and Time Formats for Macros for more details.

Advanced file monitoring is possible with the Folder Monitor through filters and a wide range of analysis tools (Dynamic Object, Numeric Value Extraction, Text Pre-Processing, String Search, and Value Map).

By default, the Folder Monitor automatically times out after 30 seconds.

To monitor a folder, you must configure the properties below:

Property Description
Folder Path Path to the folder (directory) to be monitored (Example: C:\Users\Default\Downloads).
Include Subfolders Select this option to include all sub-folders of the above-specified folder when collecting data.
Filter Files Enter a mask to have Monitoring Studio X monitor only the corresponding files. You can use the ? and * wildcards and several masks can be specified, separated by “;” (Example: .txt;myFiles?.log;file.*).
Credentials to Read the Folder Credentials required to read the folder. By default, System Credentials are used.
Display Name Name to identify the Folder instance in TrueSight Operations Management.
Internal ID ID to be used to store the Folder Monitor configuration in the PATROL Agent configuration. This Internal ID is automatically generated based on the folder path provided but can be edited if needed.
Collect Schedule How often new data is collected. A new collect can be performed from once every second, to once in a day. By default, the collect schedule is set to 2 minutes.
When Folder Is Empty Action to be performed by Monitoring Studio X on the time-based attributes (Last Modified File Elapsed Time, Longest Time File Remains In and Oldest Modified File Elapsed Time) when the monitored folder is empty.
Possible values are:
  • Do not update the time-based attributes: The attributes values are not updated, and the alerts are not cleared (Default). In this case, the attributes keep the same value as previously set upon the last collect. If the last value set was within an alarm range, the alert remains active until the value is set again, that is when the folder will no longer be empty.
  • Suspend the time-based attributes: The attributes values are not set, but any alert is cleared when the folder becomes empty. In this case, the attributes are suspended (i.e. deactivated) and immediately enabled again. The value of these attributes are not updated and the attributes remain offline in TrueSight OM until a new value is set, that is when the folder will no longer be empty. If the attributes were previously in alarm, the alert is not cleared (No PATROL event (STD/9) is triggered).
  • Set the time-based attributes to zero: The attributes values are reset to zero and all alerts are automatically acknowledged. In this case, the attributes are set to zero as long as the folder remains empty. While the value could be considered improper, it ensures that previous alerts are cleared and that the corresponding PATROL event (STD/9) is triggered (assuming that zero is out of the alarm range).
Timeout After Time in seconds after which the Folder collector will be stopped (Default: 30 seconds). When a timeout is reached, an error is reported in the Template's Collection Error Count parameter.

At this time, you can run the Dry Run feature to simulate the execution of this Monitor on a specific host and therefore verify that the output is conform to the expected result.

Refer to:

Keywords:
studio km patrol develop web
No results.