Release history for the Splunk Add-on for Sysmon
The latest version of the Splunk Add-on for Sysmon is version 4.0.2 Please see Release notes for the Splunk Add-on for Sysmon for the release notes of this latest version.
Version 4.0.1
Version 4.0.1 of the Splunk Add-on for Sysmon was released on June 5, 2024.
Compatibility
Version 4.0.0 of the Splunk Add-on for Sysmon is compatible with the following software, CIM versions, and platforms:
| Splunk platform versions | 8.2, 9.1 and later |
| CIM | 5.2 and later |
| Supported OS for data collection | Platform independent |
| Vendor products | Microsoft Sysmon version 15.0 |
Splunk Add-on for Sysmon field mapping changes
See the following sections for information on the differences between versions 3.1.0 of the Splunk Add-on for Sysmon and 4.0.0 and 4.0.1 of the Splunk Add-on for Sysmon
| Source-type | EventID | Fields added | Fields removed | 3.1.0 extractions | 4.0.0 extractions | Comments |
|---|---|---|---|---|---|---|
['xmlwineventlog']
|
4 | |||||
process_guid
|
||||||
process_id
|
||||||
['xmlwineventlog']
|
7 | |||||
loaded_file_path
|
A new field 'loaded_file_path' maps the original path of the file or module loaded by the process for events 7 | |||||
original_file_name
|
A new CIM field 'original_file_name' maps the original name of the file, not including path, for event 7. | |||||
process_id
|
||||||
process_guid
|
||||||
parent_process_exec
|
||||||
parent_process_id
|
||||||
parent_process_guid
|
||||||
parent_process_name
|
||||||
parent_process_path
|
||||||
['xmlwineventlog']
|
16 | file_path
|
||||
['xmlwineventlog']
|
27, 28 | |||||
file_access_time
|
||||||
file_hash
|
||||||
file_modify_time
|
||||||
file_name
|
||||||
file_path
|
||||||
['xmlwineventlog']
|
29 | |||||
action
|
||||||
dest
|
||||||
file_access_time
|
||||||
file_create_time
|
||||||
file_hash
|
||||||
file_name
|
||||||
file_path
|
||||||
process_guid
|
||||||
process_id
|
||||||
user
|
||||||
vendor_product
|
||||||
dvc
|
||||||
signature
|
||||||
signature_id
|
The dvc field is defined for all Sysmon events. The field value shows where an event was generated. The host field is mapped at search time to show the machine that generated the event. This is consistent with the Windows TA.
New features
Version 4.0.1 fixes known issues, See the Known Issues section of this topic for more information.
Fixed issues
Version 4.0.1 of the Splunk Add-on for Sysmon fixes the following, if any, issues.
| Date filed | Issue number | Description |
|---|---|---|
| ADDON-70336 | Automatic lookup applied to incorrect sources. |
Known issues
Version 4.0.1 of the Splunk Add-on for Sysmon has the following, if any, known issues.
| Date filed | Issue number | Description |
|---|---|---|
| 2024-09-24 | ADDON-75229 | After upgrading the Add-on from 3.0.1 to 4.0.1 start encounter the error " "Could not load lookup=LOOKUP-record_type". during the search. " |
Third-party software attributions
Version 4.0.1 of the Splunk Add-on for Sysmon does not incorporate any third-party software or libraries.
Version 4.0.0
Version 4.0.0 of the Splunk Add-on for Sysmon was released on November 17, 2023.
Compatibility
Version 4.0.0 of the Splunk Add-on for Sysmon is compatible with the following software, CIM versions, and platforms:
| Splunk platform versions | 8.2, 9.1 and later |
| CIM | 5.2 and later |
| Supported OS for data collection | Platform independent |
| Vendor products | Microsoft Sysmon version 15.0 |
Splunk Add-on for Sysmon field mapping changes
See the following sections for information on the differences between versions 3.1.0 of the Splunk Add-on for Sysmon and 4.0.0 of the Splunk Add-on for Sysmon
| Source-type | EventID | Fields added | Fields removed | 3.1.0 extractions | 4.0.0 extractions | Comments |
|---|---|---|---|---|---|---|
['xmlwineventlog']
|
4 | |||||
process_guid
|
||||||
process_id
|
||||||
['xmlwineventlog']
|
7 | |||||
loaded_file_path
|
A new field 'loaded_file_path' maps the original path of the file or module loaded by the process for events 7 | |||||
original_file_name
|
A new CIM field 'original_file_name' maps the original name of the file, not including path, for event 7. | |||||
process_id
|
||||||
process_guid
|
||||||
parent_process_exec
|
||||||
parent_process_id
|
||||||
parent_process_guid
|
||||||
parent_process_name
|
||||||
parent_process_path
|
||||||
['xmlwineventlog']
|
16 | file_path
|
||||
['xmlwineventlog']
|
27, 28 | |||||
file_access_time
|
||||||
file_hash
|
||||||
file_modify_time
|
||||||
file_name
|
||||||
file_path
|
||||||
['xmlwineventlog']
|
29 | |||||
action
|
||||||
dest
|
||||||
file_access_time
|
||||||
file_create_time
|
||||||
file_hash
|
||||||
file_name
|
||||||
file_path
|
||||||
process_guid
|
||||||
process_id
|
||||||
user
|
||||||
vendor_product
|
||||||
dvc
|
||||||
signature
|
||||||
signature_id
|
The dvc field is defined for all Sysmon events. The field value shows where an event was generated. The host field is mapped at search time to show the machine that generated the event. This is consistent with the Windows TA.
New features
Version 4.0.0 of the Splunk Add-on for Sysmon contains the following new and changed features:
- Event ID 29: FileExecutableDetected. This event is generated when Sysmon detects the creation of a new executable file (PE format).
See the following table for CIM model mapping of the new events:
| Source | EventID | CIM model |
|---|---|---|
| XmlWinEventLog | 29 | Endpoint:Filesystem |
Fixed issues
Version 4.0.0 of the Splunk Add-on for Sysmon fixes the following, if any, issues.
| Date filed | Issue number | Description |
|---|---|---|
| 2022-11-16 | ADDON-58325 | Correction of CIM mapping: New Sysmon TA does not map EventCode 7 Correctly |
| 2022-07-25 | ADDON-63579 | Splunk Add-on for Sysmon DestinationHostname field extraction problem |
| 2022-07-19 | ADDON-63507 | Splunk Add-on for Sysmon Rule field extraction problem |
| 2022-11-15 | ADDON-58175 | Update sysmon event IDs 7 and 8 |
| 2022-08-24 | ADDON-55193 | Fix action field on event ID 12 of windows sysmon |
| 2022-08-24 | ADDON-55192 | Add non DM field for file path on windows sysmon |
Known issues
Version 4.0.0 of the Splunk Add-on for Sysmon has the following, if any, known issues.
| Date filed | Issue number | Description |
|---|---|---|
| 2024-05-03 | ADDON-70336 | Automatic lookup applied to incorrect sources |
Third-party software attributions
Version 4.0.0 of the Splunk Add-on for Sysmon does not incorporate any third-party software or libraries.
Version 3.1.0
Version 3.1.0 of the Splunk Add-on for Sysmon was released on January 2023.
Compatibility
Version 3.1.0 of the Splunk Add-on for Sysmon is compatible with the following software, CIM versions, and platforms:
| Splunk platform versions | 8.1, 8.2 and later |
| CIM | 5.0 and later |
| Supported OS for data collection | Platform independent |
| Vendor products | Microsoft Sysmon version 13.33 |
Splunk Add-on for Sysmon field mapping changes
See the following sections for information on the differences between versions 2.0.0 of the Splunk Add-on for Microsoft Sysmon and 3.0.0 of the Splunk Add-on for Sysmon
| Source-type | EventID | Fields added | Fields removed | 3.0.0 extractions | 3.1.0 extractions | Comments |
|---|---|---|---|---|---|---|
['xmlwineventlog']
|
7,8 | loaded_file | A new CIM field 'loaded_file' maps the file or module loaded by the process for events 7 and 8. | |||
['xmlwineventlog']
|
27, 28 | |||||
process_id
|
||||||
process_path
|
||||||
process_exec
|
||||||
eventtype
|
||||||
process
|
||||||
os
|
||||||
action
|
||||||
tag::eventtype
|
||||||
process_hash
|
||||||
process_guid
|
||||||
dest
|
||||||
process_name
|
||||||
user
|
||||||
vendor_product
|
||||||
['xmlwineventlog']
|
src='-' | In 3.0.0, if src extracts to '-', then the extraction is visible. In 3.1.0, we are ignoring this extraction if src only extracts '-'. | ||||
['xmlwineventlog']
|
3, 24 | src_host='-' | In 3.0.0, if user_host extracts to '-', then the extraction is visible. In 3.1.0, we are ignoring this extraction if user_host only extracts '-'. | |||
['xmlwineventlog']
|
user = '-' | In 3.0.0, if user extracts to '-', then the extraction is visible. In 3.1.0, we are ignoring this extraction if user only extracts '-'. |
The dvc field is now defined for all Sysmon events. The field value shows where an event was generated The host field is mapped at search time to show the machine that generated the event. This is consistent with the Windows TA.
New features
Version 3.1.0 of the Splunk Add-on for Sysmon contains the following new and changed features:
- Sysmon could only log system action before Sysmon version 14. Version 14 introduced the following two new events:
- Event ID 27: FileBlockExecutable. This event is generated when Sysmon detects and blocks the creation of executable files. Define rules in the Sysmon config file so Sysmon can match blocks with the activity action. This feature can be used to block certain programs the crease malicious disk files. Test the configuration files intensively before using it in Production Systems.
- Event ID 28: FileBlockShredding. This event is generated when Sysmon detects and blocks file shredding from tools such as SDelete. Event 28 is also a block event, so some of the rules might cause issues on their System. Testing the configuration files should be performed intensively before deploying it in Production Systems.
See the following table for CIM model mapping of the new events:
| Source | EventID | CIM model |
|---|---|---|
| XmlWinEventLog | 27 | Endpoint |
| XmlWinEventLog | 28 | Endpoint |
Fixed issues
Version 3.1.0 of the Splunk Add-on for Sysmon fixes the following, if any, issues.
Known issues
Version 3.1.0 of the Splunk Add-on for Sysmon has the following, if any, known issues.
| Date filed | Issue number | Description |
|---|---|---|
| 2022-11-16 | ADDON-58325 | Correction of CIM mapping: New Sysmon TA does not map EventCode 7 Correctly |
| 2022-11-16 | ADDON-58323 | Correction of CIM mapping: New Sysmon TA does not map EventCode 8 Correctly |
Third-party software attributions
Version 3.1.0 of the Splunk Add-on for Sysmon does not incorporate any third-party software or libraries
Version 3.0.0
Version 3.0.0 of the Splunk Add-on for Sysmon was released on May 30, 2022.
Compatibility
Version 3.0.0 of the Splunk Add-on for Sysmon is compatible with the following software, CIM versions, and platforms:
| Splunk platform versions | 8.1, 8.2 and later |
| CIM | 5.0 and later |
| Supported OS for data collection | Platform independent |
| Vendor products | Microsoft Sysmon version 13.33 |
Splunk Add-on for Sysmon field mapping changes
See the following sections for information on the differences between versions 2.0.0 of the Splunk Add-on for Microsoft Sysmon and 3.0.0 of the Splunk Add-on for Sysmon
| Source-type | EventID | Fields added | Fields removed |
|---|---|---|---|
['xmlwineventlog']
|
8, 25, 22, 5, 15, 14, 11, 4, 2, 1, 7, 16, 6, 18, 23, 9, 12, 17 | dvc |
The dvc field is now defined for all Sysmon events. The field value shows where an event was generated The host field is mapped at search time to show the machine that generated the event. This is consistent with the Windows TA.
New features
Version 3.0.0 of the Splunk Add-on for Sysmon contains the following new and changed features: Support for WEF/WEC architectureWEF/WEC events can be found by adding to search string: _sourcetype=XmlWinEventLog:WEC-Sysmon If direct Sysmon events have to be found, the following search string can be used: _sourcetype=XmlWinEventLog:Microsoft-Windows-Sysmon/Operational
Fixed issues
Version 3.0.0 of the Splunk Add-on for Sysmon fixes the following, if any, issues.
Known issues
Version 3.0.0 of the Splunk Add-on for Sysmon has the following, if any, known issues.
Third-party software attributions
Version 3.0.0 of the Splunk Add-on for Sysmon does not incorporate any third-party software or libraries.
Version 2.0.0
Version 2.0.0 of the Splunk Add-on for Sysmon was released in February 2022.
Compatibility
Version 2.0.0 of the Splunk Add-on for Sysmon is compatible with the following software, CIM versions, and platforms:
| Splunk platform versions | 8.1, 8.2 and later |
| CIM | 5.0 and later |
| Supported OS for data collection | Platform independent |
| Vendor products | Microsoft Sysmon version 13.30 |
Splunk Add-on for Sysmon field mapping changes
See the following sections for information on the differences between versions 1.0.1 of the Splunk Add-on for Microsoft Sysmon and 2.0.0 of the Splunk Add-on for Sysmon
| Source-type | EventID | Fields added | Fields removed |
|---|---|---|---|
['xmlwineventlog']
|
8, 10 | user | |
['xmlwineventlog']
|
20 | DestinationNoQuotes | |
['xmlwineventlog']
|
21 | ConsumerNoQuotes, FilterNoQuotes |
New features
Sysmon 13.30 (schema 4.81) introduces user information for number of event IDs. The user information is in the Sysmon User field in most cases. However, in event ID 8 (https://docs.microsoft.com/en-us/sysinternals/downloads/sysmon#event-id-8-createremotethread) and event ID 10 (https://docs.microsoft.com/en-us/sysinternals/downloads/sysmon#event-id-10-processaccess) SourceUser and TargetUser fields are introduced.
Version 2.0.0 of the Splunk Add-on for Sysmon contains the following new and changed features: CIM user field is mapped from Sysmon User field for event ID 24. This is breaking change as it was extracted from the Sysmon ClientInfo field before. As inconsistencies were observed during testing, if the SourceUser and TargetUser field values are equal, the value is mapped to the user CIM field. The value for registry_key_name CIM field is represented as a path that is not in line with key names definition (https://docs.microsoft.com/en-us/windows/win32/sysinfo/structure-of-the-registry). Unfortunately, using data exposed by Sysmon, it is not possible to reliably determine key names. If SourceUser and TargetUser field values are not equal, due to known Sysmon issue (https://docs.microsoft.com/en-us/answers/questions/692991/sysmon-1330-sourceuser-and-targetuser-values-diffe.html), CIM user value cannot be reliably determined.
Fixed issues
Version 2.0.0 of the Splunk Add-on for Sysmon fixes the following, if any, issues.
Known issues
Version 2.0.0 of the Splunk Add-on for Sysmon has the following, if any, known issues.
Third-party software attributions
Version 2.0.0 of the Splunk Add-on for Sysmon does not incorporate any third-party software or libraries.
Version 1.0.0
The Splunk Add-on for Sysmon is different from the community-supported Splunk Add-on for Microsoft Sysmon.
The community-supported add-on will continue to exist, but because the Splunk-supported add-on contains enhancements to events field mappings and Common Information Model (CIM) changes, the best practice is to migrate your Microsoft Sysmon data ingestion from the community-supported add-on to the Splunk-supported add-on.
For information on the differences in the technical support for different Splunkbase app or add-ons, see the
Support content topic in the Splunk Developer Guide.
| Release notes for the Splunk Add-on for Sysmon |
This documentation applies to the following versions of Splunk® Supported Add-ons: released
Download manual
Feedback submitted, thanks!