Create Event Definitions
There are three ways to create an event definition:
This article walks through all three ways. For an overview of what an event definition is and what it is made of, see Event Definitions.
Prerequisites
Before proceeding, ensure that the following prerequisites are met:
-
You have permission to create event definitions in Graylog.
-
To create an event definition directly from search results, you have an existing search with results to select a value from.
-
To create a Sigma Rule event definition, you have imported the required Sigma Rule(s).
Create an Event Definition Through the Wizard
The wizard steps through six screens: Event Details, Condition, Additional Details, Notifications, Share, and Summary. To create an event definition through the wizard in the Graylog interface:
-
Navigate to Alerts.
-
Click the Event Definitions tab.
-
Click Create event definition in the upper right corner.
-
On the first screen, enter the required details:
Event Details-
Title: A unique name for the event definition.
-
Priority: A user-defined classification of the event's relative importance, from Informational (1) to Critical (5); defaults to Medium. See priority for what each level represents.
-
Event Summary Template (optional): The template used to generate event-specific, context-rich summaries in the Alerts page's description column. See Event Summary Template for its syntax and an example.
-
Description (optional): A longer description of the event definition.
-
Event Procedure Summary (optional): Shows any event procedures already attached (none, until you add one). Event procedures are specific, actionable instructions for resolving an identified issue. Click Add Event Procedure to create a new procedure or attach a pre-defined one from your library. See Event Procedures for complete information.
-
-
Select an event condition type from the Condition Type drop-down menu and complete its specific fields. The Available Conditions panel on the right summarizes each type as a reference. See Condition for the full list of types and links to each one's configuration details.
-
Optional: under Additional Details, add tags, MITRE ATT&CK tactics/techniques, or custom event fields. See Additional Details for what each field does.
-
Optional: in the Notifications menu, attach an alert. See the Alerts article for information on how to set one up and the alert types available.
-
Optional: in the Share menu, set collaboration and sharing options. See Share a New Entity for details.
-
Review the summary and select Create event definition.
Create an Event Definition Directly From Search Results
You can select any value in your search results to create an event definition. This event definition generates tailored alerts that include only the specific part of the query that you want to be alerted on. To do so:
-
Go to your search results.
-
Click any value in an aggregation widget, log view, or message widget.
-
Select Create event definition from the drop down menu.
-
Pick one of the Strategy by options in the dialog box that appears. You can select any of these options:
-
Exactly this value: Displays parameters related to your current search. You may add or remove any of these.
-
Any in widget: Displays parameters related to the selected value.
-
Custom: Allows you to include any part of the search query.
-
-
Click Show strategy details to select or deselect any parameters you would like to add to the event definition. The parameters you select here populate in your event definition under Filter & Aggregation.
Hint: In addition to the three options displayed above, you might be presented with other options depending on the value you select. For example, if you select an aggregation widget metric value, you are presented with additional Any in row and Any in column options.
-
Click Continue Configuration. You are redirected to the Event Definitions page. Start by giving your event definition a unique title and filling in other details in Event Details. The selections you made in steps 4 and 5 are populated in Filter & Aggregation. You can add search filters, custom fields, alerts, and collaboration in this menu.
-
After reviewing the summary of your new event definition, click Create event definition. A new event definition is created, and Graylog generates events for the given condition. If you attached a notification, you also receive alerts.
Create an Event Definition by Importing a Sigma Rule
Importing a Sigma rule requires a Graylog Security license. You don't create a Sigma rule from scratch inside Graylog, you import a Sigma rule, and Graylog converts its detection logic into an event definition. There is no built-in editor for writing or editing Sigma Rules.
To create an event definition from a Sigma rule:
-
Navigate to Alerts > Event Definitions and select Create Event Definition.
-
Choose one of the two Sigma import options:
-
Import from Sigma Git Repository: Connect a public or private repository, or a self-hosted server over HTTPS (SSH URLs aren't supported), and select one or more to import. This includes the SigmaHQ repository directly.
-
Import from Sigma File: Upload a single Sigma rule file, or a .zip archive of several, from your local system.
-
-
Configure the event definition as you would any other, by providing values for target streams, search window, execution schedule, notifications, and search filters.
-
Select Create Event Definition to finish.
Further Reading
Explore the following additional resources and recommended readings to expand your knowledge on related topics:
