Skip to content

[AI-5096] DDS: Microsoft Sysmon Agent Integration v1.0.0 #19874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 21 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
c33c702
Added Microsoft Sysmon Assets v1.0.0
mauneel-sorathia Mar 19, 2025
fe22edb
Resolved log pipeline test failures
mauneel-sorathia Mar 19, 2025
cba325b
Merge branch 'master' into microsoft-sysmon-assets-v1.0.0
mauneelsorathia-crest Mar 19, 2025
2aa16d4
Resolved log pipeline test failure
mauneel-sorathia Mar 19, 2025
bf2dcb4
Updated a dashboard image
mauneel-sorathia Mar 19, 2025
bb25cfa
Added logo svg
mauneel-sorathia Mar 21, 2025
e5b2b7c
Merge branch 'master' into microsoft-sysmon-assets-v1.0.0
mauneelsorathia-crest Mar 21, 2025
42e9025
Updated log pipeline
mauneel-sorathia Mar 28, 2025
fff7cdf
Resolved log pipeline failures
mauneel-sorathia Mar 28, 2025
33bf1f3
Updated asset files
mauneel-sorathia Mar 28, 2025
cdf49fe
Updated dashboar images
mauneel-sorathia Mar 28, 2025
3bfb29f
Merge branch 'master' into microsoft-sysmon-assets-v1.0.0
mauneelsorathia-crest Mar 28, 2025
6da2f5f
Update microsoft_sysmon/README.md
mauneelsorathia-crest Apr 1, 2025
d9c6d7c
Update microsoft_sysmon/README.md
mauneelsorathia-crest Apr 1, 2025
12bf81b
Update microsoft_sysmon/README.md
mauneelsorathia-crest Apr 1, 2025
23cf7f6
Update microsoft_sysmon/README.md
mauneelsorathia-crest Apr 1, 2025
767f48c
Merge branch 'master' into microsoft-sysmon-assets-v1.0.0
mauneelsorathia-crest Apr 1, 2025
3e1b9f7
Updated changelog file and codeowners
mauneel-sorathia Apr 4, 2025
d482112
Merge branch 'master' into microsoft-sysmon-assets-v1.0.0
mauneelsorathia-crest Apr 4, 2025
afef9c2
Updated dashboard image
mauneel-sorathia Apr 8, 2025
b5133b5
Merge branch 'master' into microsoft-sysmon-assets-v1.0.0
mauneelsorathia-crest Apr 8, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,11 @@ datadog_checks_base/datadog_checks/base/checks/windows/ @DataDog/wi
/metabase/manifest.json @DataDog/saas-integrations @DataDog/documentation
/metabase/assets/logs/ @DataDog/saas-integrations @DataDog/documentation @DataDog/logs-backend

/microsoft_sysmon/ @DataDog/saas-integrations
/microsoft_sysmon/*.md @DataDog/saas-integrations @DataDog/documentation
/microsoft_sysmon/manifest.json @DataDog/saas-integrations @DataDog/documentation
/microsoft_sysmon/assets/logs/ @DataDog/saas-integrations @DataDog/documentation @DataDog/logs-backend @DataDog/logs-core

/mimecast/ @DataDog/saas-integrations
/mimecast/*.md @DataDog/saas-integrations @DataDog/documentation
/mimecast/manifest.json @DataDog/saas-integrations @DataDog/documentation
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/config/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -386,6 +386,8 @@ integration/mesos_slave:
- mesos_slave/**/*
integration/metabase:
- metabase/**/*
integration/microsoft_sysmon:
- microsoft_sysmon/**/*
integration/milvus:
- milvus/**/*
integration/mimecast:
Expand Down
4 changes: 4 additions & 0 deletions microsoft_sysmon/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# CHANGELOG - Microsoft Sysmon

<!-- towncrier release notes start -->

117 changes: 117 additions & 0 deletions microsoft_sysmon/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
# Agent Integration: Microsoft Sysmon

## Overview

[Microsoft Sysmon][4] is a Windows system service and device driver that provides detailed logging of system activity, including process creation, network connections, file modifications, and registry changes.

This integration enriches and ingests the [Sysmon event logs][5]. Use the pre-built dashboard to get a high-level view of the Sysmon events helping security teams monitor system activity.

## Setup

### Installation

To install the Microsoft Sysmon integration, run the following Agent installation command and the steps below. For more information, see the [Integration Management][6] documentation.

**Note**: This step is not necessary for Agent version >= 7.66.0.

Run powershell.exe as admin and execute the following command:
```powershell
& "$env:ProgramFiles\Datadog\Datadog Agent\bin\agent.exe" integration install datadog-microsoft_sysmon==1.0.0
```

### Configuration

#### Configure Log Collection

1. Collecting logs is disabled by default in the Datadog Agent. Enable it in the `datadog.yaml` file with:

```yaml
logs_enabled: true
```

2. Add this configuration block to your `microsoft_sysmon.d/conf.yaml` file to start collecting your Microsoft Sysmon logs:

```yaml
logs:
- type: windows_event
channel_path: "Microsoft-Windows-Sysmon/Operational"
source: microsoft-sysmon
service: microsoft-sysmon
sourcecategory: windowsevent
```

3. [Restart the Agent][3].

#### Configure Sysmon

Follow these steps to install Sysmon:
1. Download the zip file from the [Sysmon download page][4]. Extract its zip file content.
2. Create an XML file for configuring Sysmon. For example, if you want to monitor processes created by apps from AppData folders, the configuration file will look like content shown below. You can add more event filters under the `EventFiltering` XML tag for other events in the same way.

```xml
<Sysmon schemaversion="4.90">
<EventFiltering>
<ProcessCreate onmatch="include">
<Image condition="contains">C:\Users\*\AppData\Local\Temp\</Image>
<Image condition="contains">C:\Users\*\AppData\Roaming\</Image>
</ProcessCreate>
</EventFiltering>
</Sysmon>
```

3. Execute the command as admin from the extracted folder:

```powershell
.\Sysmon -i [<configfile>]
```

**Note:** Sysmon is highly configurable using the configuration (XML) file which allows you to:
- Control which events to monitor
- Filter events based on processes, paths, etc.

Enabling too many event types can result in excessive data ingestion. Only critical security events should be enabled based on the threat model and monitoring needs.
These events should be selectively enabled for critical system directories, processes, and users to avoid unnecessary log noise.

For more details on configuration, please refer to the [Sysmon docs][7].

### Validation

[Run the Agent's status subcommand][8] and look for `microsoft_sysmon` under the Checks section.

## Data Collected

### Logs

The Microsoft Sysmon integration collects the following [Sysmon event logs][5]:
- Process activity logs
- Network activity logs
- File activity logs
- Registry activity logs
- WMI activity logs
- Sysmon service activity logs
- Named Pipe and Clipboard activity logs

### Metrics

The Microsoft Sysmon integration does not include any metrics.

### Events

The Microsoft Sysmon integration does not include any events.

### Service Checks

The Microsoft Sysmon integration does not include any service checks.

## Support

Need help? Contact [Datadog support][1].

[1]: https://docs.datadoghq.com/help/
[2]: https://app.datadoghq.com/account/settings/agent/latest
[3]: https://docs.datadoghq.com/agent/configuration/agent-commands/#restart-the-agent
[4]: https://learn.microsoft.com/en-us/sysinternals/downloads/sysmon
[5]: https://learn.microsoft.com/en-us/sysinternals/downloads/sysmon#events
[6]: https://docs.datadoghq.com/agent/guide/integration-management/?tab=windowspowershell#install
[7]: https://learn.microsoft.com/en-us/sysinternals/downloads/sysmon#configuration-files
[8]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
11 changes: 11 additions & 0 deletions microsoft_sysmon/assets/configuration/spec.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Microsoft Sysmon
files:
- name: microsoft_sysmon.yaml
options:
- template: logs
example:
- type: windows_event
channel_path: "Microsoft-Windows-Sysmon/Operational"
source: microsoft-sysmon
service: microsoft-sysmon
sourcecategory: windowsevent
5,541 changes: 5,541 additions & 0 deletions microsoft_sysmon/assets/dashboards/microsoft_sysmon_overview.json

Large diffs are not rendered by default.

Loading