You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/sentinel/cef-syslog-ama-overview.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ author: yelevin
5
5
ms.author: yelevin
6
6
ms.topic: concept-article
7
7
ms.custom: linux-related-content
8
-
ms.date: 05/13/2024
8
+
ms.date: 06/27/2024
9
9
#Customer intent: As a security operator, I want to understand how Microsoft Sentinel collects Syslog and CEF messages with the Azure Monitor Agent so that I can determine if this solution fits my organization's needs.
10
10
---
11
11
@@ -83,7 +83,11 @@ As part of the setup process, create a data collection rule and install the Azur
83
83
84
84
After you create the DCR, and AMA is installed, run the "installation" script on the log forwarder. This script configures the Syslog daemon to listen for messages from other machines, and to open the necessary local ports. Then configure the security devices or appliances as needed.
85
85
86
-
For more information, see [Ingest Syslog and CEF messages to Microsoft Sentinel with the Azure Monitor Agent](connect-cef-syslog-ama.md).
86
+
For more information, see the following articles:
87
+
88
+
-[Ingest Syslog and CEF messages to Microsoft Sentinel with the Azure Monitor Agent](connect-cef-syslog-ama.md)
89
+
-[CEF via AMA data connector - Configure specific appliance or device for Microsoft Sentinel data ingestion](unified-connector-cef-device.md)
90
+
-[Syslog via AMA data connector - Configure specific appliance or device for Microsoft Sentinel data ingestion](unified-connector-syslog-device.md)
Copy file name to clipboardExpand all lines: articles/sentinel/connect-cef-syslog-ama.md
+41-19Lines changed: 41 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,21 @@
1
1
---
2
-
title: Ingest Syslog CEF messages to Microsoft Sentinel - AMA
2
+
title: Ingest syslog CEF messages to Microsoft Sentinel - AMA
3
3
description: Ingest syslog messages from linux machines, devices, and appliances to Microsoft Sentinel using data connectors based on the Azure Monitor Agent (AMA).
4
4
author: yelevin
5
5
ms.author: yelevin
6
6
ms.topic: how-to
7
7
ms.custom: linux-related-content
8
-
ms.date: 05/13/2024
9
-
#Customer intent: As a security operator, I want to ingest and filter Syslog and CEF messages from Linux machines and from network and security devices and appliances to my Microsoft Sentinel workspace, so that security analysts can monitor activity on these systems and detect security threats.
8
+
ms.date: 06/27/2024
9
+
appliesto:
10
+
- Microsoft Sentinel in the Azure portal
11
+
- Microsoft Sentinel in the Microsoft Defender portal
12
+
ms.collection: usx-security
13
+
#Customer intent: As a security operator, I want to ingest and filter syslog and CEF messages from Linux machines and from network and security devices and appliances to my Microsoft Sentinel workspace, so that security analysts can monitor activity on these systems and detect security threats.
10
14
---
11
15
12
-
# Ingest Syslog and CEF messages to Microsoft Sentinel with the Azure Monitor Agent
16
+
# Ingest syslog and CEF messages to Microsoft Sentinel with the Azure Monitor Agent
13
17
14
-
This article describes how to use the **Syslog via AMA** and **Common Event Format (CEF) via AMA** connectors to quickly filter and ingest Syslog messages, including messages in Common Event Format (CEF), from Linux machines and from network and security devices and appliances. To learn more about these data connectors, see [Syslog and Common Event Format (CEF) via AMA connectors for Microsoft Sentinel](cef-syslog-ama-overview.md).
18
+
This article describes how to use the **Syslog via AMA** and **Common Event Format (CEF) via AMA** connectors to quickly filter and ingest syslog messages, including messages in Common Event Format (CEF), from Linux machines and from network and security devices and appliances. To learn more about these data connectors, see [Syslog and Common Event Format (CEF) via AMA connectors for Microsoft Sentinel](cef-syslog-ama-overview.md).
15
19
16
20
> [!NOTE]
17
21
> Container Insights now supports the automatic collection of Syslog events from Linux nodes in your AKS clusters. To learn more, see [Syslog collection with Container Insights](../azure-monitor/containers/container-insights-syslog.md).
@@ -22,11 +26,18 @@ Before you begin, you must have the resources configured and the appropriate per
22
26
23
27
### Microsoft Sentinel prerequisites
24
28
25
-
For Microsoft Sentinel, install the appropriate solution and make sure you have the permissions to complete the steps in this article.
29
+
Install the appropriate Microsoft Sentinel solution and make sure you have the permissions to complete the steps in this article.
26
30
27
-
- Install the appropriate solution—**Syslog** and/or **Common Event Format** from the **Content hub** in Microsoft Sentinel. For more information, see [Discover and manage Microsoft Sentinel out-of-the-box content](sentinel-solutions-deploy.md).
31
+
- Install the appropriate solution from the **Content hub** in Microsoft Sentinel. For more information, see [Discover and manage Microsoft Sentinel out-of-the-box content](sentinel-solutions-deploy.md).
32
+
- Identify which data connector the Microsoft Sentinel solution requires —**Syslog via AMA** or **Common Event Format (CEF) via AMA** and whether you need to install the **Syslog** or **Common Event Format** solution. To fulfill this prerequisite,
33
+
- In the **Content hub**, select **Manage** on the installed solution and review the data connector listed.
34
+
- If either **Syslog via AMA** or **Common Event Format (CEF) via AMA** isn't installed with the solution, identify whether you need to install the **Syslog** or **Common Event Format** solution by finding your appliance or device from one of the following articles:
28
35
29
-
- Your Azure account must have the following Azure role-based access control (Azure RBAC) roles:
36
+
-[CEF via AMA data connector - Configure specific appliance or device for Microsoft Sentinel data ingestion](unified-connector-cef-device.md)
37
+
-[Syslog via AMA data connector - Configure specific appliance or device for Microsoft Sentinel data ingestion](unified-connector-syslog-device.md)
38
+
39
+
Then install either the **Syslog** or **Common Event Format** solution from the content hub to get the related AMA data connector.
40
+
- Have an Azure account with the following Azure role-based access control (Azure RBAC) roles:
30
41
31
42
| Built-in role | Scope | Reason |
32
43
| ------------- | ----- | ------ |
@@ -50,13 +61,13 @@ If you're collecting messages from a log forwarder, the following prerequisites
50
61
51
62
- For space requirements for your log forwarder, refer to the [Azure Monitor Agent Performance Benchmark](../azure-monitor/agents/azure-monitor-agent-performance.md). You can also review [this blog post](https://techcommunity.microsoft.com/t5/microsoft-sentinel-blog/designs-for-accomplishing-microsoft-sentinel-scalable-ingestion/ba-p/3741516), which includes designs for scalable ingestion.
52
63
53
-
- Your log sources, security devices, and appliances, must be configured to send their log messages to the log forwarder's Syslog daemon instead of to their local Syslog daemon.
64
+
- Your log sources, security devices, and appliances, must be configured to send their log messages to the log forwarder's syslog daemon instead of to their local syslog daemon.
54
65
55
66
### Machine security prerequisites
56
67
57
68
Configure the machine's security according to your organization's security policy. For example, configure your network to align with your corporate network security policy and change the ports and protocols in the daemon to align with your requirements. To improve your machine security configuration, [secure your VM in Azure](../virtual-machines/security-policy.md), or review these [best practices for network security](../security/fundamentals/network-best-practices.md).
58
69
59
-
If your devices are sending Syslog and CEF logs over TLS because, for example, your log forwarder is in the cloud, you need to configure the Syslog daemon (`rsyslog` or `syslog-ng`) to communicate in TLS. For more information, see:
70
+
If your devices are sending syslog and CEF logs over TLS because, for example, your log forwarder is in the cloud, you need to configure the syslog daemon (`rsyslog` or `syslog-ng`) to communicate in TLS. For more information, see:
60
71
61
72
-[Encrypt Syslog traffic with TLS – rsyslog](https://www.rsyslog.com/doc/v8-stable/tutorials/tls_cert_summary.html)
62
73
-[Encrypt log messages with TLS – syslog-ng](https://support.oneidentity.com/technical-documents/syslog-ng-open-source-edition/3.22/administration-guide/60#TOPIC-1209298)
@@ -68,15 +79,15 @@ The setup process for the Syslog via AMA or Common Event Format (CEF) via AMA d
68
79
1. Install the Azure Monitor Agent and create a Data Collection Rule (DCR) by using either of the following methods:
69
80
-[Azure or Defender portal](?tabs=syslog%2Cportal#create-data-collection-rule)
1. If you're collecting logs from other machines using a log forwarder, [**run the "installation" script**](#run-the-installation-script) on the log forwarder to configure the Syslog daemon to listen for messages from other machines, and to open the necessary local ports.
82
+
1. If you're collecting logs from other machines using a log forwarder, [**run the "installation" script**](#run-the-installation-script) on the log forwarder to configure the syslog daemon to listen for messages from other machines, and to open the necessary local ports.
72
83
73
84
Select the appropriate tab for instructions.
74
85
75
86
# [Azure or Defender portal](#tab/portal)
76
87
77
88
### Create data collection rule
78
89
79
-
To get started, open the data connector in Microsoft Sentinel and create a data connector rule.
90
+
To get started, open either the**Syslog via AMA** or **Common Event Format (CEF) via AMA** data connector in Microsoft Sentinel and create a data connector rule.
80
91
81
92
1. For Microsoft Sentinel in the [Azure portal](https://portal.azure.com), under **Configuration**, select **Data connectors**.<br> For Microsoft Sentinel in the [Defender portal](https://security.microsoft.com/), select **Microsoft Sentinel** > **Configuration** > **Data connectors**.
82
93
@@ -113,7 +124,7 @@ In the **Resources** tab, select the machines on which you want to install the A
113
124
114
125
### Select facilities and severities
115
126
116
-
Be aware that using the same facility for both Syslog and CEF messages might result in data ingestion duplication. For more information, see [Data ingestion duplication avoidance](cef-syslog-ama-overview.md#data-ingestion-duplication-avoidance).
127
+
Be aware that using the same facility for both syslog and CEF messages might result in data ingestion duplication. For more information, see [Data ingestion duplication avoidance](cef-syslog-ama-overview.md#data-ingestion-duplication-avoidance).
117
128
118
129
1. In the **Collect** tab, select the minimum log level for each facility. When you select a log level, Microsoft Sentinel collects logs for the selected level and other levels with higher severity. For example, if you select **LOG_ERR**, Microsoft Sentinel collects logs for the **LOG_ERR**, **LOG_CRIT**, **LOG_ALERT**, and **LOG_EMERG** levels.
119
130
@@ -152,9 +163,9 @@ Create a JSON file for the data collection rule, create an API request, and send
152
163
153
164
1. Prepare a DCR file in JSON format. The contents of this file is the request body in your API request.
154
165
155
-
For an example, see [Syslog/CEF DCR creation request body](api-dcr-reference.md#syslogcef-dcr-creation-request-body). To collect Syslog and CEF messages in the same data collection rule, see the example [Syslog and CEF streams in the same DCR](#syslog-and-cef-streams-in-the-same-dcr).
166
+
For an example, see [Syslog/CEF DCR creation request body](api-dcr-reference.md#syslogcef-dcr-creation-request-body). To collect syslog and CEF messages in the same data collection rule, see the example [Syslog and CEF streams in the same DCR](#syslog-and-cef-streams-in-the-same-dcr).
156
167
157
-
- Verify that the `streams` field is set to `Microsoft-Syslog` for Syslog messages, or to `Microsoft-CommonSecurityLog` for CEF messages.
168
+
- Verify that the `streams` field is set to `Microsoft-Syslog` for syslog messages, or to `Microsoft-CommonSecurityLog` for CEF messages.
158
169
- Add the filter and facility log levels in the `facilityNames` and `logLevels` parameters. See [Examples of facilities and log levels sections](#examples-of-facilities-and-log-levels-sections).
159
170
160
171
1. Create an API request in a REST API client of your choosing.
@@ -240,13 +251,13 @@ This example collects events from the `cron`, `daemon`, `local0`, `local3` and `
240
251
241
252
### Syslog and CEF streams in the same DCR
242
253
243
-
This example shows how you can collect Syslog and CEF messages in the same DCR.
254
+
This example shows how you can collect syslog and CEF messages in the same DCR.
244
255
245
256
The DCR collects CEF event messages for:
246
257
- The `authpriv` and `mark` facilities with the `Info`, `Notice`, `Warning`, `Error`, `Critical`, `Alert`, and `Emergency` log levels
247
258
- The `daemon` facility with the `Warning`, `Error`, `Critical`, `Alert`, and `Emergency` log levels
248
259
249
-
It collects Syslog event messages for:
260
+
It collects syslog event messages for:
250
261
- The `kern`, `local0`, `local5`, and `news` facilities with the `Critical`, `Alert`, and `Emergency` log levels
251
262
- The `mail` and `uucp` facilities with the `Emergency` log level
252
263
@@ -328,7 +339,7 @@ It collects Syslog event messages for:
328
339
329
340
## Run the "installation" script
330
341
331
-
If you're using a log forwarder, configure the Syslog daemon to listen for messages from other machines, and open the necessary local ports.
342
+
If you're using a log forwarder, configure the syslog daemon to listen for messages from other machines, and open the necessary local ports.
332
343
333
344
1. From the connector page, copy the command line that appears under **Run the following command to install and apply the CEF collector:**
334
345
@@ -342,7 +353,7 @@ If you're using a log forwarder, configure the Syslog daemon to listen for messa
342
353
1. Sign in to the log forwarder machine where you just installed the AMA.
343
354
344
355
1. Paste the command you copied in the last step to launch the installation script.
345
-
The script configures the `rsyslog`or`syslog-ng` daemon to use the required protocol and restarts the daemon. The script opens port 514 to listen to incoming messages in both UDPandTCP protocols. To change this setting, refer to the Syslog daemon configuration file according to the daemon type running on the machine:
356
+
The script configures the `rsyslog`or`syslog-ng` daemon to use the required protocol and restarts the daemon. The script opens port 514 to listen to incoming messages in both UDPandTCP protocols. To change this setting, refer to the syslog daemon configuration file according to the daemon type running on the machine:
346
357
- Rsyslog: `/etc/rsyslog.conf`
347
358
- Syslog-ng: `/etc/syslog-ng/syslog-ng.conf`
348
359
@@ -352,6 +363,15 @@ If you're using a log forwarder, configure the Syslog daemon to listen for messa
352
363
> To avoid [Full Disk scenarios](../azure-monitor/agents/azure-monitor-agent-troubleshoot-linux-vm-rsyslog.md) where the agent can't function, we recommend that you set the `syslog-ng` or `rsyslog` configuration not to store unneeded logs. A Full Disk scenario disrupts the function of the installed AMA.
353
364
> For more information, see [RSyslog](https://www.rsyslog.com/doc/master/configuration/actions.html) or [Syslog-ng](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.26/administration-guide/34#TOPIC-1431029).
354
365
366
+
## Configure the security device or appliance
367
+
368
+
Get specific instructions to configure your security device or appliance by going to one of the following articles:
369
+
370
+
- [CEF via AMA data connector - Configure specific appliances and devices for Microsoft Sentinel data ingestion](unified-connector-cef-device.md)
371
+
- [Syslog via AMA data connector - Configure specific appliances and devices for Microsoft Sentinel data ingestion](unified-connector-syslog-device.md)
372
+
373
+
Contact the solution provider for more information or where information is unavailable for the appliance or device.
374
+
355
375
## Test the connector
356
376
357
377
Verify that logs messages from your linux machine or security devices and appliances are ingested into Microsoft Sentinel.
@@ -406,3 +426,5 @@ Verify that logs messages from your linux machine or security devices and applia
406
426
407
427
- [Syslog and Common Event Format (CEF) via AMA connectors for Microsoft Sentinel](cef-syslog-ama-overview.md)
408
428
- [Data collection rules in Azure Monitor](../azure-monitor/essentials/data-collection-rule-overview.md)
429
+
- [CEF via AMA data connector - Configure specific appliance or device for Microsoft Sentinel data ingestion](unified-connector-cef-device.md)
430
+
- [Syslog via AMA data connector - Configure specific appliance or device for the Microsoft Sentinel data ingestion](unified-connector-syslog-device.md)
0 commit comments