The Data Enrichment feature of the ESM allows you to enrich events with context that is not in the original event sent by the upstream data source, such as an email address, phone number, or host location information. This data becomes part of the parsed event, and is stored with the event just like the original fields. There are a wide range of uses for Data Enrichment. In this example, we will use it to populate full user display names in Windows events.
In many enterprises, Windows login names can be difficult for people to parse. There are a wide range of user name schemes that you might follow, and in many circumstances this results in user names that are random-looking strings of letters and numbers, or other strings that are difficult for a human operator to understand. In this example of using enrichment, we will leverage AD lookups to add the full user name to Windows events.
To accomplish this, we will configure a 2 column enrichment, which uses the Source User field from a Windows event to map that user's real name (display name) and then populate the display name in the event.
To pull in full user name and enrich using Active Directory:.
- Select System Properties/Data Enrichement, and click Add to create a new Data Enrichment.
- From the Data Enrichment Property of the ESM add a new data enrichment.
- Set the Lookup Type to String.
- Set the Enrichment Type to String.
- The Pull Frequency should be no more frequent then daily unless the local AD environment is updated much more frequently.
- Define the Active Directory (or LDAP) Source. The username and password supplied must have read access to user objects in AD.
- Create the Query.
- The Lookup Attribute is sAMAccountName.
- The Enrichment Attribute is displayName.
- The simplest query would be (objectClass=person). This query will return a list of all objects in AD which are classified as a person. More complex queries can be used if a limited or different set of results is desired.
- A test of the above query returns the following details. The test function only returns a maximum of 5 values, regardless of the number of actual entries. Click Next> once the query succeeds.
- Add a Destination.
- Click Add.
- Select an event source or sources for events that are to be enriched. As a suggestion, select your MS Windows data sources.
- Select the Lookup Field. In this case it will be the Source User field. The lookup field is the value that exists in the event, which we will use as the index for our lookup.
- Select the Enrichment Field. The Enrichment Field is the field where the enrichment value will be written to. A good option here might be User_Nickname or Contact_Name.
- Click Finish to save. Once the enrichment is complete, write the enrichment setting.
- After the enrichment settings are written to the devices, you must select Run Now or the enrichment values will not be retrieved from the data source until the ‘Daily Trigger Time’ value set in step 1 is reached.
- An event enriched as above will have the Full Name written into the Contact_Name Field. (In step 4 the value was returned as eposa = ePO Service Account, written as shown below)