Splunk® Cloud Services

SPL2 Search Reference

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

lookup command examples

The following are examples for using the SPL2 lookup command. To learn more about the lookup command, see How the lookup command works.

1. Put corresponding information from a lookup dataset into your events

This example appends the data returned from your search results with the data in the users lookup dataset using the uid field.

The users lookup dataset contains this data:

uid username department
1066 Claudia Garcia Engineering
1690 Rutherford Sullivan Engineering
1815 Vanya Patel IT
1862 Wei Zhang Engineering
1916 Alex Martin Personnel

The events look something like this:

_time host action department uid
2020-04-13 13:02:45.000 PM mailsv2 Failed password Engineering 1066
2020-04-13 10:52:41.000 AM mailsv1 Failed password IT 1815
2020-04-13 06:23:48.000 AM mailsv3 Session closed 1916
2020-04-13 06:23:48.000 AM mailsv3 Failed password
2020-04-12 20:18:36.000 PM mailsv1 Session closed Engineering 1690

The third event is missing the department. The fourth event is missing the department and the uid.

When you run the following search, for search results that contains a uid field, the value in that field are matched with the uid field in the users lookup dataset.

... | lookup users uid OUTPUTNEW username, department

The username and department fields from the users lookup dataset are appended to each search result. If the search results already have the username and department fields, the OUTPUTNEW argument only fills in missing values in those fields.

_time host action department uid username
2020-04-13 13:02:45.000 PM mailsv2 Failed password Engineering 1066 Claudia Garcia
2020-04-13 10:52:41.000 AM mailsv1 Failed password IT 1815 Vanya Patel
2020-04-13 06:23:48.000 AM mailsv3 Session closed Personnel 1916 Alex Martin
2020-04-13 06:23:48.000 AM mailsv3 Failed password
2020-04-12 20:18:36.000 PM mailsv1 Session closed Engineering 1690 Rutherford Sullivan

Because the third event was missing the department, the department name is added to the search results. The fourth event was missing the department and the uid. Because there is no uid to match on, there are no changes to the search results for that event.

2. Replace data in your events with data from a lookup dataset

This example replaces the data returned from the search results with data in the addresses lookup dataset. It maps each value in the CustID field in the lookup dataset with the matching value in the cid field in the search results. Find the corresponding CustAddress value and use the address in the lookup dataset to replace the cAddress in the search results.

...| lookup addresses CustID AS cid OUTPUT CustAddress AS cAddress

3. Lookup users and return the corresponding group the user belongs to

There is a KV store lookup dataset called usertogroup. The dataset contains multiple fields, including user and group. The values in the user field in the lookup dataset are mapped to the corresponding value of the field local_user in the search results. For any entries that match, the value of the group field in the lookup dataset is written to the field user_group in the search results.

... | lookup usertogroup user AS local_user OUTPUTNEW group


See also

lookup command
lookup command overview
lookup command syntax details
lookup command usage
Last modified on 29 April, 2020
PREVIOUS
lookup command usage
  NEXT
mvexpand command overview

This documentation applies to the following versions of Splunk® Cloud Services: current


Was this documentation topic helpful?

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