Search Reference

 


Introduction

Welcome to the Search Reference

Welcome to the Search Reference

This manual is a reference guide for the Search Processing Language (SPL). The Search Reference contains 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.

Getting Started

If you are new to Splunk Enterprise and search, start with the Search Tutorial. This tutorial introduces you to the Search and Reporting application. The tutorial guides you through adding data to Splunk Enterprise, searching your data, and building simple reports and dashboards.

Before you can start using search on your own Splunk Enterprise instance:

Search Manual

The Search Manual contains detailed information about creating and optimizing searches.

  • Types of searches
  • Retrieving events
  • Specifying time ranges
  • Using subsearches
  • Creating statistical tables and charts
  • Grouping and correlating events
  • Predicting future events

Quick Reference Information

The Splunk Enterprise Quick Reference Guide contains:

  • Explanations about Splunk Enterprise features
  • Common search commands
  • Tips on optimizing searches
  • Functions for the eval and stats commands
  • 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 Command Reference section of this manual.


The search command cheatsheet is a great reference to keep handy as you work with the search processing language (SPL). This cheatsheet contains descriptions and examples.


Before you continue, read How to use this manual for the conventions and rules used in this manual.

Generate a PDF

If you would like a PDF version of the Search Reference, click the red Download Search Reference as PDF link on the left side of this page. A PDF version of the manual is generated for you. You can save the PDF or print it out to read later.

This documentation applies to the following versions of Splunk: 6.0 , 6.0.1 , 6.0.2 , 6.0.3 , 6.0.4 , 6.0.5 , 6.0.6 , 6.0.7 , 6.0.8 , 6.0.9 , 6.1 , 6.1.1 , 6.1.2 , 6.1.3 , 6.1.4 , 6.1.5 , 6.1.6 , 6.1.7 , 6.1.8 , 6.2.0 , 6.2.1 , 6.2.2 , 6.2.3 , 6.2.4 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.

Feedback submitted, thanks!