Skip to content

Files

Latest commit

d987da0 · Apr 26, 2022

History

History
61 lines (38 loc) · 3.7 KB

surface-custom-details-in-alerts.md

File metadata and controls

61 lines (38 loc) · 3.7 KB
title description author ms.topic ms.date ms.author ms.custom
Surface custom details in Microsoft Sentinel alerts | Microsoft Docs
Extract and surface custom event details in alerts in Microsoft Sentinel analytics rules, for better and more complete incident information
yelevin
how-to
04/26/2022
yelevin
ignite-fall-2021

Surface custom event details in alerts in Microsoft Sentinel

[!INCLUDE Banner for top of topics]

Introduction

Scheduled query analytics rules analyze events from data sources connected to Microsoft Sentinel, and produce alerts when the contents of these events are significant from a security perspective. These alerts are further analyzed, grouped, and filtered by Microsoft Sentinel's various engines and distilled into incidents that warrant a SOC analyst's attention. However, when the analyst views the incident, only the properties of the component alerts themselves are immediately visible. Getting to the actual content - the information contained in the events - requires doing some digging.

Using the custom details feature in the analytics rule wizard, you can surface event data in the alerts that are constructed from those events, making the event data part of the alert properties. In effect, this gives you immediate event content visibility in your incidents, enabling you to triage, investigate, draw conclusions, and respond with much greater speed and efficiency.

The procedure detailed below is part of the analytics rule creation wizard. It's treated here independently to address the scenario of adding or changing custom details in an existing analytics rule.

How to surface custom event details

  1. From the Microsoft Sentinel navigation menu, select Analytics.

  2. Select a scheduled query rule and click Edit. Or create a new rule by clicking Create > Scheduled query rule at the top of the screen.

  3. Click the Set rule logic tab.

  4. In the Alert enrichment section, expand Custom details.

    :::image type="content" source="media/surface-custom-details-in-alerts/alert-enrichment.png" alt-text="Find and select custom details":::

  5. In the now-expanded Custom details section, add key-value pairs corresponding to the details you want to surface:

    1. In the Key field, enter a name of your choosing that will appear as the field name in alerts.

    2. In the Value field, choose the event parameter you wish to surface in the alerts from the drop-down list. This list will be populated by values corresponding to the fields in the tables that are the subject of the rule query.

      :::image type="content" source="media/surface-custom-details-in-alerts/custom-details.png" alt-text="Add custom details":::

  6. Click Add new to surface more details, repeating the last steps to define key-value pairs.

    If you change your mind, or if you made a mistake, you can remove a custom detail by clicking the trash can icon next to the Value drop-down list for that detail.

  7. When you have finished defining custom details, click the Review and create tab. Once the rule validation is successful, click Save.

    [!NOTE]

    Service limits

    • You can define up to 20 custom details in a single analytics rule.

    • The size limit for all custom details, collectively, is 2 KB.

Next steps

In this document, you learned how to surface custom details in alerts using Microsoft Sentinel analytics rules. To learn more about Microsoft Sentinel, see the following articles: