4.16. Local file system monitor service

This page describes the configuration options available for the local file system monitor service.

4.16.1. General description

The local file system monitor service allows the server to monitor local file systems and emit audit log events once files or sub-directories are changed inside the monitored path.

If the configured path does not exist, the service will fail to start.

If the configured path to monitor is removed while the service is running, its content is reported as removed and the service will continue to monitor the path and wait for it to be created. The service monitor will not stop or fail.

4.16.2. Configuration options

Below you can find the list of available configuration options for services of the monitor type, other than the standard service configuration options.

4.16.2.1. source_path

Optional:

Yes

Default value:

Disabled

Values:

• Absolute path on the local file system.
• Relative path to the server installation folder.

From version:

2.10.0

To version:

None

Description:

Path to the monitored source folder.

4.16.2.2. recursive

Optional:

Yes

Default value:

No

From version:

2.10.0

Values:

• Yes
• No

Description:

Determines whether the monitor should look for source files and folders only in the configured path, or recurse in all its descendant folders.

4.16.2.3. changes_poll_interval

Default value:

10

Optional:

Yes

From version:

3.0.0

Values:

• Number of seconds.

Description:

Frequency of the checks for changes in the monitored path, in seconds.

Lower values help detect changes quicker, but increase the load, CPU, and network usage for both the local and the remote servers.

4.16.2.4. stable_interval

Default value:

10

Optional:

Yes

From version:

2.10.0

Values:

• Number of seconds.

Description:

Number of seconds after which a file is considered stable if no changes are made to it.

When a new file is created or a file starts to be changed, it is not processed right away. It might be that an external program is still changing its content after the initial file creation or file modification. This will allow the external program to finish handling the file. After the last modification is observed, a configured time interval is allowed to pass. The file is processed only if no other changes to the file are observed after the configured interval. Each change will reset the interval.

This needs to be a multiple of changes_poll_interval.

4.16.2.5. source_filter

Default value:

Disabled

Optional:

Yes

From version:

2.10.0

Values:

• Globbing expression containing wildcard characters.
• Regular expression
• Empty
• Disabled

Description:

Globbing expression or regular expression used to select source files to be transferred. For more details see the matching expression documentation

Only files matching the expression will be transferred.

Only file names are filtered, all folder names will be transferred.

Leave it empty or set it to Disabled to transfer all files.

4.16.2.6. warn_non_modified_files_interval

Optional:

Yes

Default value:

0

Values:

• Number of seconds.

From version:

3.5.0

Description:

Age in seconds after which an event is triggered for files which are not modified in that time.

A separate event is emitted for each file.

Set it to 0 to disable triggering this type of events.

Attention

This option is in the experimental stage. It might be changed in future versions in a way which is not backward compatible.