Splunk® Enterprise Security

Administer Splunk Enterprise Security

Download manual as PDF

Download topic as PDF

Customize notable event settings in Splunk Enterprise Security

As a Splunk Enterprise Security administrator, you can make configuration changes to notable events.

Change notable event fields

Make changes to the fields displayed on the Incident Review dashboard for notable events on the Incident Review Settings dashboard. For example, change the label of a field in the notable event details, remove a field, or add a field to the Additional Fields section of the notable event details. Changes that you make to notable event fields affect all notable events.

  1. From the Splunk Enterprise Security menu bar, select Configure > Incident Management > Incident Review Settings.
  2. Review the Incident Review - Event Attributes.
  3. Click Edit to change a field or the label for a specific field that appears on Incident Review.
  4. Click Remove to remove a field from the notable event details on the Incident Review dashboard.
  5. Click Save to save your changes.

Add a field to the notable event details

A field appears in the Additional fields of the notable event details if the field exists in the correlation search results and Incident Review can display the field. To add a field to the notable event details, first make sure that the correlation search results include the field and then make sure that Incident Review can display the field.

  1. Determine if the field you want to see is included in the correlation search results. Run the correlation search on the Search page to review the output or the search syntax.
    • If the field exists in the search results, go to step four.
    • If the field does not exist in the search results, go to step two.
  2. Modify the correlation search to include the field.
    • If you can edit the search with the guided search editor, add the field as an aggregate function with an alias. Use the values function to return all possible values of a given field, or the latest function to return the most recent value for the field.
    • If you created the search manually, modify the search to extract the fields. Make sure that you do not modify the correlation criteria when you modify the search.
      • If the search does not include statistical transformations, add | fields + newfieldname to the end of the search, where newfieldname is the name of the new field you want to see in the additional details.
      • If the search does include statistical transformations, extract the fields when you perform the statistical transformation. For example, if your search includes a stats search | stats count by src | where count>5, the src and count fields appear in the notable event details. To add the dest field to the notable event details, you might change the search to the following: | stats values(dest) as dest,count by src.
  3. Verify changes to correlation searches on the Search page before saving them.
  4. Add the field to the list of additional fields.
    1. From the Splunk Enterprise Security menu bar, select Configure > Incident Management > Incident Review Settings.
    2. Click Add new entry to add the new field to the Additional Fields section of the notable event details.
    3. Type a Label to use as the display name of the field in the notable event details.
    4. Type a Field to match the field that you want to appear in the notable event details.
    5. Click Done.
    6. Click Save.

Manage notable event statuses

An analyst assigns a status to a notable event in the investigation workflow. The status aligns with the stages of an investigation, and can be used to review and report on the progress of a notable event investigation on the Incident Review Audit dashboard.

To see the available statuses for notable events, select Configure > Incident Management > Status Configuration.

Label Description Can be edited
Unassigned Used by Enterprise Security when an error prevents the notable event from having a valid status assignment. No
New (default) The notable event has not been reviewed. No
In Progress An investigation or response to the notable event is in progress. Yes
Pending Closure of the notable event is pending some action. Yes
Resolved The notable event has been resolved and awaits verification. Yes
Closed The notable event has been resolved and verified. Yes

Every notable event is assigned a status of New by default when it is created by a correlation search. You can customize notable event statuses to match an existing workflow at your organization.

Edit notable event statuses

Change the available statuses for notable events on the Edit Notable Event Status page.

  1. On the Splunk Enterprise Security toolbar, select Configure > Incident Management > Status Configuration.
  2. Select a notable event status to open the Edit Notable Event Status page.
  3. (Optional) Change the Label or Description.

You cannot edit the Unassigned and New statuses because they are defaults used when creating notable events.

Manage notable event status history

Notable events are associated with users, statuses, and comments. Changes made to status names only affect the name of a status, not the status ID assigned to the notable event in the notable index.

If you change the name of a default notable event status, the name changes for both past and future notable events. For example, if you rename "pending" to "waiting for customer", all notable events with a status of "pending" will then have a status of "waiting for customer". The status ID assigned to the notable events remains the same.

Notable event status transitions

Statuses represent the steps in investigating a notable event. Status transitions define the path of a notable event investigation.

An analyst changes the status of the notable event as the investigation progresses. To change the status of a notable event:

  • The analyst must be a member of a role that has permission to change a status. The ability to change notable event statuses is available to the ess_analyst and ess_admin roles by default.
  • The follow-on status must allow a transition from the current status. By default, every status can transition to any other status. For example, an analyst can change the status of a notable event with the New status to any other status, such as Closed.

Restrict notable event status transitions

You can define a status workflow and limit which statuses analysts can transition to other statuses, creating a path for a notable event investigation. By default, a notable event in any status can be changed to any other status.

Prerequisites

  • You must have the ess_admin role or your role must be assigned the Edit Statuses capability. For more information about user roles and capabilities, see Configure users and roles in the Installation and Upgrade Manual.
  • Define a status workflow for notable event investigations. Determine which statuses to require, and whether analysts must follow a specific sequence of statuses before completing the workflow. Determine whether any roles can bypass the full workflow.

Steps

  1. On the Splunk Enterprise Security toolbar, select Configure > Incident Management > Status Configuration.
  2. Select a notable event status to open the Edit Notable Event Status page.
  3. In Status Transitions, modify the To Status fields. These fields control which statuses analysts can transition a notable event to if it is in the status that you are editing.
    1. To define which roles are allowed to transition a notable event to the selected status, choose the Authorization field and add or remove roles.
    2. To remove a transition for an event to the selected status, choose Unselect All.
  4. Click Save.

Example of restricting notable event status transitions

This example walks you through setting up restricting status transitions for analysts. Restrict status transitions so that analysts must follow a path from New, to In Progress or Pending, to Resolved, then to Closed.

  1. On the Splunk Enterprise Security toolbar, select Configure > Incident Management > Status Configuration.
  2. Restrict the transitions from the New status. Select the New status to open the Edit Investigation Status page.
  3. In Status Transitions, select the roles for the Resolved status and deselect the check box for the ess_analyst role.
  4. Select the roles for the Closed status and deselect the check box for the ess_analyst role.
  5. Click Save to save the changes to the New status.
  6. Restrict the transitions on the In Progress and Pending statuses to prevent the ess_analyst role from transitioning to New or to Closed.
  7. Select the In Progress status.
  8. In Status Transition, select the roles for the New status and deselect the check box for the ess_analyst role. Repeat for the Closed status.
  9. Click Save to save the changes to the In Progress status.
  10. Repeat steps 8 and 9 for the Pending status.
  11. Restrict the Resolved status. Click the Investigation tab and select the Resolved status.
  12. In Status Transition, select the roles for the New status and deselect the check box for the ess_analyst role. Repeat for the In Progress and Pending statuses.
  13. Click Save to save the changes to the Resolved status.
  14. Restrict the transitions for the Closed status. Select the Closed status.
  15. In Status Transition, select the roles for the New status and deselect the check box for the ess_analyst role. Repeat for the In Progress, Pending, and Resolved statuses.
  16. Click Save to save the changes for the Closed status.

Create a status

Create a status for the notable event investigation workflow.

Prerequisites

If you restrict status transitions, determine where the new status is needed in the workflow and whether any roles can bypass the new status in the workflow.

Steps

  1. On the Splunk Enterprise Security toolbar, select Configure > Incident Management > Status Configuration.
  2. Select Create New Status > Notable.
  3. Type a Label that represents the status on the Incident Review dashboard.
    For example, Waiting on ITOps.
  4. (Optional) Type a description that appears on the Status Configuration page.
    For example, Waiting on the IT operations department.
  5. (Optional) Select the check box for Default Status. Select this check box if you want to replace the New status as the default status for newly-created notable events.
  6. (Optional) Select the check box for End Status. Select this check box if you are adding an additional Closed status for notable events, such as False Positive.
  7. (Optional) Deselect the check box for Enabled. Deselect this check box if you want to create this status without using it.
  8. Update the status transitions by modifying the To Status fields. If you do not select any roles that can transition from this status to another one, no one will be able to move the notable event to a different status after transitioning the notable event to this status. If you do not restrict status transitions, select all roles for each status.
  9. Click Save.

If you restrict status transitions based on user roles, modify the status transitions for each status that can transition to this new status.

Create and manage notable event suppressions

You can hide notable events from the Incident Review dashboard by creating a notable event suppression.

A suppression is a search filter that hides additional notable events from view, and is used to stop excessive or unwanted numbers of notable events from appearing on the Incident Review dashboard. Notable events that meet the search conditions are still created and added to the notable index. Suppressed notable events continue to contribute to notable event counts on the Security Posture and auditing dashboards.

To prevent notable events that meet certain conditions from being created, see Throttle the number of response actions generated by a correlation search.

You can create a suppression filter in two ways.

Create a suppression from Notable Event Suppressions

  1. Select Configure > Incident Management > Notable Event Suppressions.
  2. Click Create New Suppression.
  3. Enter a Name and Description for the suppression filter.
  4. Enter a Search to use to find notable events to be suppressed.
    The search goes directly into the eventtype stanza, so the use of pipes is limited. See eventtypes.conf in the Splunk Enterprise Admin Manual.
  5. Set the Expiration Time. This defines a time limit for the suppression filter. The expiration time does not prevent the suppression from working, so events within the specified time range will continue to be suppressed until you disable the suppression. Notable events that fall outside the expiration time are not suppressed.

Edit notable event suppressions

  1. Select Configure > Incident Management > Notable Event Suppressions.
  2. Select a notable event suppression to open the Edit Notable Event Suppression page.
  3. Edit the Description and Search fields used for the suppression filter.
  4. Click Save.

Disable notable event suppressions

  1. Select Configure > Incident Management > Notable Event Suppressions.
  2. Select Disable in the Status column for the notable event suppression.

Remove a notable event suppression

  1. From the Splunk platform toolbar, select Settings > Event types.
  2. Search for the the suppression event: notable_suppression-<suppression_name>.
  3. Select delete in the Actions column for the notable event suppression.

Audit notable event suppressions

Audit notable event suppressions with the Suppression Audit dashboard. See Suppression Audit in Use Splunk Enterprise Security.

PREVIOUS
Manually create a notable event in Splunk Enterprise Security
  NEXT
Expand tokens in notable events using the expandtoken command

This documentation applies to the following versions of Splunk® Enterprise Security: 5.0.0, 5.0.1, 5.1.0, 5.1.1, 5.2.0, 5.2.1, 5.2.2, 5.3.0, 5.3.1, 6.0.0


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters