highlight
Description
Highlights specified terms in the events list. Matches a string or list of strings and highlights them in the display in Splunk Web. The matching is not case sensitive.
Syntax
highlight <string>...
Required arguments
- <string>
- Syntax: <string> ...
- Description: A space-separated list of strings to highlight in the results. The list you specify is not case-sensitive. Any combination of uppercase and lowercase letters that match the string are highlighted.
Usage
The highlight
command is a distributable streaming command. See Command types.
The string that you specify must be a field value. The string cannot be a field name.
You must use the highlight
command in a search that keeps the raw events and displays output on the Events tab. You cannot use the highlight command with commands, such as stats
which produce calculated or generated results.
Examples
Example 1:
Highlight the terms "login" and "logout".
... | highlight login,logout
Example 2:
Highlight the phrase "Access Denied".
... | highlight "access denied"
See also
head | history |
This documentation applies to the following versions of Splunk Cloud Platform™: 8.2.2112, 8.2.2201, 8.2.2202, 8.2.2203, 9.0.2205, 9.0.2208, 9.0.2209, 9.0.2303, 9.0.2305, 9.1.2308, 9.1.2312, 9.2.2403, 9.2.2406 (latest FedRAMP release)
Feedback submitted, thanks!