Search for transactions
This documentation does not apply to the most recent version of Splunk. Click here for the latest version.
Search for transactions
Search for transactions using the transaction search command either in Splunk Web or at the CLI. The transaction command yields groupings of events which can be used in reports. To use transaction, either call a transaction type (that you configured via transactiontypes.conf), or define transaction constraints in your search by setting the search options of the transaction command.
Search options
Transactions returned at search time consist of the raw text of each event, the shared event types, and the field values. Transactions also have additional data that is stored in the fields: duration and transactiontype.
-
durationcontains the duration of the transaction (the difference between the timestamps of the first and last events of the transaction). -
transactiontypeis the name of the transaction (as defined intransactiontypes.confby the transaction's stanza name).
You can add transaction to any search. For best search performance, craft your search and then pipe it to the transaction command.
Follow the transaction command with the following options. Note: Some transaction options do not work in conjunction with others.
fields=<quoted comma-separated list of fields>
- If set, each event must have the same field(s) to be considered part of the same transaction.
- Specify multiple fields in quotes, eg.
fields="field1, field2" - Events with common field names and different values will not be grouped.
- For example, if
fields=host, then a search result that hashost=mylaptopcan never be in the same transaction as a search result with </code>host=myserver</code>. - A search result that has no
hostvalue can be in a transaction with a result that hashost=mylaptop.
- For example, if
- Note: When specifying more than one field, you must quote all the fields, like this:
transaction fields="host,thread"
match=closest
- Specify the matching type to use with a transaction definition.
- The only value supported currently is closest.
maxspan=[<integer> s|m|h|d]
- Set the maximum pause between the events in a transaction.
- Can be in seconds, minutes, hours or days.
- For example: 5s, 6m, 12h or 30d.
- Defaults to 2s.
maxpause=[<integer> s|m|h|d]
- Specifies the maximum pause between transactions.
- Requires there be no pause between a transaction's events greater than maxpause.
- If the value is negative, the maxspause constraint is disabled.
- The default maxpause is 2 seconds.
startswith=<string>
- Specify a SQLite expression that must be true to begin a transaction.
- Strings must be quoted with " ".
- You can use SQLite wildcards (%) and use single quotes(' ') to specify a literal term.
- This syntax refers to an event type name, not an event string itself
endswith=<quoted string>
- Specify a SQLite expression that must be true to end a transaction.
- Strings must be quoted with " ".
- You can use SQLite wildcards (%) and use single quotes(' ') to specify a literal term.
- This syntax refers to an event type name, not an event string itself
Transactions and macro search
Transactions and macro searches are a powerful combination that allow substitution into your transaction searches. Make a transaction search and then save it with $field$ to allow substitution.
For more information about macro searches, see "Design macro searches" in this manual.
Example transaction search
Run a search that groups together all of the web pages a single user (or client IP address) looked at over a time range.
This search takes events from the access logs, and creates a transaction from events that share the same clientip value that occurred within 5 minutes of each other (within a 3 hour time span).
sourcetype=access_combined | transaction fields=clientip maxpause=5m maxspan=3hThis documentation applies to the following versions of Splunk: 3.4.10 , 3.4.11 , 3.4.12 , 3.4.13 , 3.4.14 View the Article History for its revisions.