File Status Test

This test reports whether configured files are available or not, and if available, reports the size of the individual files.

Target of the test : Any Unix or Windows host

Agent deploying the test : An internal agent

Outputs of the test : One set of results for every configured file path

Configurable parameters for the test
  1. TEST PERIOD - How often should the test be executed
  2. Host - The host for which the test is to be configured
  3. filename - Provide a comma-separated list of the full path of the files that are to be monitored. For instance, on a Unix host, your specification can be: opt/usr/alert.log,opt/tmp/error.log. On a Windows host, your specification can be: C:\eGurkha\agent\logs\agentout.log,C:\eGurkha\agent\logs\agenterr.log.

    Also, if you want to monitor files with names that include a date, then your filename specification should indicate the date format used for naming the files. For instance, to monitor all files that are named error, but which end with dates that are of the format DDMMYY, your filename specification should be: C:\logs\errorDDMMYY. As per this specification, files such as error21082015, error22082015, and error24082015 will be monitored.

    Your filename specification can include file names with dates and without dates – for eg., C:\eGurkha\agent\logs\agentout.log,C:\eGurkha\agent\logs\agenterr.log, C:\logs\errorDDMMYY,C:\errorlogs\MMDDYYYY_error

    If you wish to monitor the latest file in a folder that consists of too many files with the same extension, say for example .log, then your FILENAME specification should be : C:\Temp\*.log.

    Note:

    Wildcard characters are not supported while entering the full path of the files in the FILENAME text box. So, provide the exact path of the files in the same.

  4. date pattern – Using this test, you can also monitor all files with names that include a date. If your filename specification above includes files with dates, then set the date pattern flag to Yes. If this is done, then the test will look for date patterns in your filename specification. If your filename specification does not include data patterns, set this flag to No. If this is done, then the test will not look for date patterns in your filename specification. Say that you include a file name that embeds a date pattern in your filename specification – eg., C:\logs\errorMMDDYYYY - and set the date pattern flag to No. In this case, the test will disregard the date pattern MMDDYYYY, and will instead search for a file with the name, errorMMDDYYYY.
  5. MAX AGE IN HOURS - Specify the time duration in hours beyond which this test should report whether/not the file configured against the FILENAME is updated. By default, this parameter is set to none.
Measurements made by the test
Measurement Description Measurement Unit Interpretation

File availability:

Indicates whether this file is currently available or not.

Percent

This measure reports the value 100, if the file is available in the configured path. If the files is not available, a value of 0 is reported.

File size:

Indicates the current size of this file.

MB

This measure reports the size of a file only if the File availability measure returns a value of 100 for that file -  i.e., only when the file is available.

File growth during the last measurement period:

Indicates the increase in the size of this file since the last measurement period.

KB

A consistent increase in the value of this measure indicates that the file size is increasing steadily.

Is the file modified?

Indicates whether/not this file was modified.

 

If the size of the file increased from the last measurement period, then this measure will report the value Yes. If there is no change in file size since the last measurement period, then this measure will report the value No.

The numeric values that correspond to these measure values are as follows:

Measure Value Numeric Value
Yes 100
No 0

Note:

By default, this test reports the Measure Values listed in the table above to indicate whether/not a file has grown. In the graph of this measure however, the same is represented using the numeric equivalents only.

Is the file not updated above configured hours?

Indicates whether this file is not updated since the time duration specified against the MAX AGE IN HOURS parameter.

 

If this file is not updated beyond the specified time duration, then this measure will report a value Yes. Otherwise, this measure will report the value No.

The numeric values that correspond to these measure values are as follows:

Measure Value Numeric Value
Yes 1
No 0

Note:

By default, this test reports the Measure Values listed in the table above to indicate whether his file was not updated beyond the specified time duration. In the graph of this measure however, the same is represented using the numeric equivalents only.