Search Reference

 


scrub

scrub

Synopsis

Anonymizes the search results.

Syntax

scrub [public-terms=<filename>] [private-terms=<filename>] [name-terms=<filename>] [dictionary=<filename>] [timeconfig=<filename>]

Optional arguments

public-terms
Syntax: public-terms=<filename>
Description: Specify a filenname that includes the public terms to be anonymized.
private-terms
Syntax: private-terms=<filename>
Description: Specify a filenname that includes the private terms to be anonymized.
name-terms
Syntax: name-terms=<filename>
Description: Specify a filenname that includes names to be anonymized.
dictionary
Syntax: dictionary=<filename>
Description: Specify a filename that includes a dictionary of terms to be anonymized. Defaults to dictionary and configuration files found in $SPLUNK_HOME/etc/anonymizer .
timeconfig
Syntax: timeconfig=<filename>
Description: Specify a filename that includes time configurations to be anonymized.

Description

Anonymizes the search results by replacing identifying data - usernames, ip addresses, domain names, etc. - with fictional values that maintain the same word length. For example, it may turn the string user=carol@adalberto.com into user=aname@mycompany.com. This lets Splunk users share log data without revealing confidential or personal information. By default the dictionary and configuration files found in $splunk_home/etc/anonymizer are used. These can be overridden by specifying arguments to the scrub command. The arguments exactly correspond to the settings in the stand-alone splunk anonymize command, and are documented there.

Anonymizes all attributes, exception those that start with _ (except _raw) or date_, or the following attributes: eventtype, linecount, punct, sourcetype, timeendpos, timestartpos.

Examples

Example 1: Anonymize the current search results.

... | scrub

Answers

Have questions? Visit Splunk Answers and see what questions and answers the Splunk community has using the scrub command.

This documentation applies to the following versions of Splunk: 4.1 , 4.1.1 , 4.1.2 , 4.1.3 , 4.1.4 , 4.1.5 , 4.1.6 , 4.1.7 , 4.1.8 , 4.2 , 4.2.1 , 4.2.2 , 4.2.3 , 4.2.4 , 4.2.5 , 4.3 View the Article History for its revisions.


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

Was this documentation topic helpful?

If you'd like to hear back from us, please provide your email address:

We'd love to hear what you think about this topic or the documentation as a whole. Feedback you enter here will be delivered to the documentation team.