Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

Common file-based plugin advanced settings

You can use the following advanced settings to fine tune many file-based sources.

Common file-based plugin advanced settings

Parameter Default value Description
Identifier Override hostname/IP You can override the device identifier for this source.
Filename pattern *.* Only files that match this pattern are considered; this is an OS file filter.
Tuning Profile
  • Automatic Tuning
  • Low Event Rate
  • Medium Event Rate
  • High Event Rate
  • Max Event Rate
  • Manual Tuning
Automatic tuning Determines how to poll for events automatically and adjusts itself over time
Low event rate Less than 1 event per minute, poll every 10 minutes, 100 events at a time.
Medium event rate Less than 10 events per second, poll every 30 seconds, 200 events at a time.
High event rate Less than 500 events per second, poll every 3 seconds, 2000 events at a time.
Max event rate More than 500 events per second, poll continuously, 5000 events at a time.
Manual Tuning Manually set the polling interval, events per pass, and batch size.
Manual Tuning
  • Polling Interval
  The length of time (milliseconds) between polls.
  • Events per pass
  Maximum events to collect at each polling interval.
  • Events per batch
  Number of events to fetch per call to the source.
Filter enabled Checkbox Turn the filter on or off.
  • Predefined Filters
  No Description
  • Filter
  An Event filter
File monitor type
  • Auto
  • Notification based
  • Folder scanning
Auto Uses Notification based on the local system and Folder scanning (new files) on remote devices.
Notification based Uses the Windows folder monitoring system. Not applicable on remote devices.
Folder Scanning Scans a folder for new files created after the bookmark timestamp.
Files to Process
  • New Files
  • All Files
Which files to accept when the system starts and there is no bookmark.
All Files Scans a folder for new files created after the bookmark timestamp. If no bookmark exists, all files are processed.
New Files Scans a folder for new files created after the bookmark timestamp. If no bookmark exists, all files are processed.
File reader type
  • Text (file opened when reading)
  • Text (file held open)
The type of file reader that should be used to read the contents of the file.
File reader encoding
  • UTF8 (no conversion)
  • ANSI (convert to UTF8)
  • UTF16 (convert to UTF8
How to deal with files without a BOM.