Monitor changes to your file system
Monitor changes to your file system
|This feature has been deprecated.|
| This feature has been deprecated as of Splunk Enterprise version 5.0. This means that although it continues to function in version 6.x of Splunk Enterprise, it might be removed in a future version. As an alternative, you can:
For a list of all deprecated features, see the topic "Deprecated features" in the Release Notes.
The Splunk Enterprise file system change monitor is useful for tracking changes in your file system. The file system change monitor watches any directory you specify and generates an event when that directory undergoes any change. It is completely configurable and can detect when any file on the system is edited, deleted, or added (not just Splunk-specific files). For example, you can tell the file system change monitor to watch
/etc/sysconfig/ and alert you any time the system's configurations are changed.
Configure the file system change monitor in inputs.conf.
Important: If you want to use this feature with forwarding, to send the events to a remote indexer, you must either use a heavy forwarder or follow the configuration instructions provided below in "Use with a universal forwarder".
Note: If you're interested in auditing file reads on Windows, check out this topic on the Splunk Community best practices Wiki. Some users might find it more straightforward to use Windows native auditing tools.
How the file system change monitor works
The file system change monitor detects changes using:
- modification date/time
- group ID
- user ID
- file mode (read/write attributes, etc.)
- optional SHA256 hash of file contents
You can configure the following features of the file system change monitor:
- whitelist using regular expressions
- specify files that will be checked, no matter what
- blacklist using regular expressions
- specify files to skip
- directory recursion
- including symbolic link traversal
- scanning multiple directories, each with their own polling frequency
- cryptographic signing
- creates a distributed audit trail of file system changes
- indexing entire file as an event on add/change
- size cutoffs for sending entire file and/or hashing
- all change events indexed by, and searchable through, Splunk Enterprise
Caution: Do not configure the file system change monitor to monitor your root file system. This can be dangerous and time-consuming if directory recursion is enabled.
Configure the file system change monitor
By default, the file system change monitor generates audit events whenever the contents of
$SPLUNK_HOME/etc/ are changed, deleted, or added to. When you start Splunk Enterprise for the first time, it generates an audit event for each file in the
$SPLUNK_HOME/etc/ directory and all subdirectories. Any time after that, any change in configuration (regardless of origin) generates an audit event for the affected file(s). If you have
signedaudit=true, the file system change audit event will be indexed into the audit index (
signedaudit is not turned on, by default, Splunk Enterprise writes the events to the main index unless you specify another index.
Note: The file system change monitor does not track the user name of the account executing the change, only that a change has occurred. For user-level monitoring, consider using native operating system audit tools, which have access to this information.
To use the file system change monitor to watch any directory, add or edit an
[fschange] stanza to
$SPLUNK_HOME/etc/system/local/ or your own custom application directory in
$SPLUNK_HOME/etc/apps/. For information on configuration files in general, see "About configuration files" in the Admin manual.
Note: You must restart Splunk Enterprise any time you make changes to the
Here is the syntax for the
[fschange:<directory or file to monitor>] <attribute1> = <val1> <attribute2> = <val2> ...
Note the following:
- Splunk Enterprise monitors all adds/updates/deletes to the directory and its subdirectories.
- Any change generates an event that Splunk indexes.
<directory or file to monitor>defaults to
All attributes are optional. Here is the list of available attributes:
| ||The index to store all events generated.|| |
| ||If true, recurse all directories within the directory specified in <code[fschange]</code>.||true|
| ||If true, the file system change monitor follows symbolic links.|| false
Caution: If you are not careful when setting
| ||Check this directory for changes every N seconds.|| 3600 seconds
| || * Calculate a SHA1 hash for every file that is less than or equal to N size in bytes.
||-1 (no hashing used for change detection).|
| || * Send cryptographically signed add/update/delete events.
Note: When setting
| || * Send the full event if an add or update change is detected.
| || * Only send the full event if the size of the event is less than or equal to N bytes.
| || * Set the source type for events from this input.
| || * Injects a delay specified by ||n/a|
| || * The delay in milliseconds to use after processing every |
| ||Each of these filters will apply from left to right for each file or directory that is found during the monitors poll cycle. See the next section for information on defining filters.||n/a|
Define a filter
To define a filter to use with the
filters attribute, add a
[filter...] stanza as follows:
[filter:blacklist:backups] regex1 = .*bak regex2 = .*bk [filter:whitelist:code] regex1 = .*\.c regex2 = .*\.h [fschange:/etc] filters = backups,code
Splunk Enterprise handles fschange whitelist and blacklist logic similarly to typical firewalls. The events run down through the list of filters until they reach their first match. If the first filter to match an event is a whitelist, the event will be indexed. If the first filter to match an event is a blacklist, the event will not be indexed. If an event reaches the end of the chain with no matches, it will be indexed. This means that there is an implicit "all pass" built in. To default to a situation where events are not indexed if they don't match a whitelist explicitly, end the chain with a blacklist that will match all remaining events.
... filters = <filter1>, <filter2>, ... terminal-blacklist [filter:blacklist:terminal-blacklist] regex1 = .?
Important: If you ever blacklist a directory including via a terminal blacklist at the end of a series of whitelists, then Splunk Enterprise blacklists all its subfolders and files - they will not pass any whitelist. To accommodate this, whitelist all desired folders and subfolders explicitly ahead of the blacklist items in your filters.
This configuration monitors files in the specified directory with the extensions
.log and ignores all others.
Note: In this example, a directory could be blacklisted. If this is the case, Splunk Enterprise would blacklist all of its subfolders and files as well -- only files in the specified directory would be monitored.
[filter:whitelist:configs] regex1 = .*\.config regex2 = .*\.xml regex3 = .*\.properties regex4 = .*\.log [filter:blacklist:terminal-blacklist] regex1 = .? [fschange:/var/apache] index = sample recurse = true followLinks = false signedaudit = false fullEvent = true sendEventMaxSize = 1048576 delayInMills = 1000 filters = configs,terminal-blacklist
Use with a universal forwarder
To forward file system change monitor events from a universal forwarder, you must set
signedaudit = false and
[fschange:<directory or file to monitor>] signedaudit = false index=_audit
With this workaround, Splunk Enterprise indexes file system change monitor events into the
_audit index with
sourcetype set to
source set to
fschangemonitor, instead of the default value of
audittrail for both
This documentation applies to the following versions of Splunk: 6.0 , 6.0.1 , 6.0.2 , 6.0.3 , 6.0.4 , 6.0.5 , 6.0.6 , 6.0.7 , 6.1 , 6.1.1 , 6.1.2 , 6.1.3 , 6.1.4 , 6.1.5 , 6.1.6 , 6.2.0 , 6.2.1 , 6.2.2