Splunk® Enterprise

Knowledge Manager Manual

Download manual as PDF

Download topic as PDF

Define event types in Splunk Web

An event type represents a search that returns a specific type of event or a useful collection of events. Every event that can be returned by that search gets an association with that event type. For example, say you have this search:

sourcetype=access_combined status=200 action=purchase

If you save that search as an event type named successful_purchase, any event that could be returned by that search gets eventtype=successful_purchase added to it at search time. This happens even if you are searching for something completely different.

And later, if you want to build a search that works with events that match that event type, include eventtype=access_combined in the search string.

A single event can match multiple event types. When an event matches two or more event types, eventtype acts as a multivalue field.

Save a search you ran as an event type

When you run a search, you can save that search as an event type. Event types usually represent searches that return a specific type of event, or that return a useful variety of events.

When you create an event type, the event type definition is added to eventtypes.conf in $SPLUNK_HOME/etc/users/<your-username>/<app>/local/, where <app> is your current app context. If you change the permissions on the event type to make it available to all users (either in the app, or globally to all apps), the Splunk platform moves the event type to $SPLUNK_HOME/etc/apps/<App>/local/.

Prerequisities

Saving a search as an event type

  1. In the Search view, run a search.
  2. Click Save As and select Event Type.
  3. Give the event type a unique Name.
  4. (Optional) Add one or more comma-separated Tag(s).

    You can apply the same tag to event types that produce similar results. A search that is just on that tag returns the set of events that collectively belong to those event types.

  5. (Optional) Select a Color.

    This causes a band of color to appear at the start of the listing for any event that fits this event type. For example, this event matches an event type that has a Color of Purple.
    6 4 0 event type coloring.png
    You can change the color of an event type (or remove its color entirely) by editing it in Settings.

  6. (Optional) Give the event type a Priority.

    Priority affects the display of events that match two or more event types. 1 is the best Priority and 10 is the worst. See About event type priorities.

  7. Click Save to save the new event type.

    You can access the list of event types that you and other users have created at Settings > Event types.

Any event type that you create with this method also appears on the Event Types listing page in Settings. You can update the event type in the Event Types listing page.

Event Types page in Settings

The Event Types page in Settings displays a list of the event types that you have permission to view or edit. You can use the Event Types page to create event types and maintain existing event types.

Add an event type in Settings

You can create a new event type through the Event Types page.

Prerequisites

Adding a new event type in Settings

  1. Select Settings > Event Types.
  2. Click New.

    6 4 0 settings event types add new.png

  3. (Optional) Change the Destination App value to the correct app for the event type, if it is not your current app context.
  4. Provide a unique Name for the event type.
  5. Enter the Search String for the event type.

    This search consistently returns a specific kind of event.

  6. (Optional) Add one or more comma-separated Tag(s).

    You can apply the same tag to event types that produce similar results. A search that is just on that tag returns the set of events that collectively belong to those event types.

  7. (Optional) Select a Color.

    This causes a band of color to appear at the start of the listing for any event that fits this event type.

  8. (Optional) Give the event type a Priority.

    Priority affects the display of events that match two or more event types. 1 is the best Priority and 10 is the worst.

    Priority determines the order of the event type listing in the expanded event. It also determines which color displays for the event type if two or more of the event types matching the event have a defined Color value.
    For more see About event type priorities.

  9. Click Save to save the event type.


Note: All event types are initially created for a specific Splunk app. To make a particular event type available to all users on a global basis, you have to give all roles read or write access to the Splunk app and make it available to all Splunk apps. For more information about setting permissions for event types (and other knowledge object types), see Manage knowledge object permissions, in this manual.

Update an event type in Settings

Prerequisites

Steps
You can update the definition of any event type that you have created or which you have permissions to edit.

  1. Navigate to Settings > Event Types.
  2. Locate the event type that you would like to update in the Event Types listing page and click its name.
  3. Update the Search String, Tag(s), Color, and Priority of the event type as necessary.
  4. Click Save to save your changes.
PREVIOUS
About event types
  NEXT
About event type priorities

This documentation applies to the following versions of Splunk® Enterprise: 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.4.7, 6.4.8, 6.5.0, 6.5.1, 6.5.1612 (Splunk Cloud only), 6.5.2, 6.5.3, 6.5.4, 6.5.5, 6.6.0, 6.6.1, 6.6.2, 6.6.3


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