Welcome to the Search Reference
This manual is a reference guide for the Search Processing Language (SPL). In this manual you will find a catalog of the search commands with complete syntax, descriptions, and examples. Additionally, this manual includes quick reference information about the categories of commands, the functions you can use with commands, and how SPL relates to SQL.
If you are new to Splunk software and searching, start with the Search Tutorial. This tutorial introduces you to the Search & Reporting application. The tutorial guides you through uploading data to your Splunk deployment, searching your data, and building simple charts, reports, and dashboards.
After you complete the Search Tutorial, and before you start using Splunk software on your own data you should:
- Add data to your Splunk instance. See Getting Data In.
- Understand how indexing works and how data is processed. See Managing Indexers and Clusters of Indexers.
- Learn about fields and knowledge objects, such as hosts, source types, and event types. See the Knowledge Manager Manual.
The Search Manual is a companion manual to the Search Reference. The Search Manual contains detailed information about creating and optimizing searches.
- Types of searches
- Retrieving events
- Specifying time ranges
- Optimizing searches
- Using subsearches
- Creating statistical tables and charts
- Grouping and correlating events
- Predicting future events
- Managing jobs
Quick Reference Information
The Quick Reference Guide contains:
- Explanations about Splunk features
- Common search commands
- Tips on optimizing searches
- Functions for the
- Search examples
- Regular expressions
- Formats for converting strings into timestamps
The search commands by category topic organizes the commands by the type of action that the command performs.
For example, commands in the reporting category, are used to build transforming searches. Reporting commands return statistical data tables that are required for charts and other kinds of data visualizations.
This topic contains a brief description of each command along with a link to the details about the command in the Search Commands section of this manual.
Before you continue, see Understanding SPL syntax for the conventions and rules used in this manual.
Understanding SPL syntax
This documentation applies to the following versions of Splunk Cloud™: 6.6.3, 7.2.7, 7.0.11, 7.0.2, 7.0.3, 7.0.0, 7.0.5, 7.0.8, 7.1.3, 7.1.6, 7.2.3, 7.2.4, 7.2.6