Admin Manual

 


About the Splunk Admin Manual
How Splunk Works

transactiontypes.conf

This documentation does not apply to the most recent version of Splunk. Click here for the latest version.

transactiontypes.conf

Use transactiontypes.conf to define transactions to use in searches. Each transaction type is defined by a stanza, where the transaction name is contained in [brackets]. Specify constraints for each transaction by using the same options that are defined for the transaction search command.

Transactions you define in transactiontypes.conf can be overridden by setting constraints with transaction while searching.

To learn more about how transaction types work, read the section on transaction types.


transactiontypes.conf.spec

# Copyright (C) 2005-2008 Splunk Inc.  All Rights Reserved.  Version 3.0 
#
# This file contains all possible attributes and value pairs for a transactiontypes.conf
# file.  Use this file to configure transaction searches and their properties.
#
# There is a transactiontypes.conf in $SPLUNK_HOME/etc/system/default/.  To set custom configurations, 
# place a transactiontypes.conf in $SPLUNK_HOME/etc/system/local/. You must restart Splunk to
# enable configurations.
#
# To learn more about configuration files (including precedence) please see the documentation 
# located at http://www.splunk.com/base/Documentation/latest/Admin/HowDoConfigurationFilesWork.
# Copyright (C) 2005-2008 Splunk Inc.  All Rights Reserved.  Version 3.0 
#
# This file contains all possible attributes and value pairs for a transactiontypes.conf
# file.  Use this file to configure transaction searches and their properties.
#
# There is a transactiontypes.conf in $SPLUNK_HOME/etc/system/default/.  To set custom configurations, 
# place a transactiontypes.conf in $SPLUNK_HOME/etc/system/local/. You must restart Splunk to
# enable configurations.
#
# To learn more about configuration files (including precedence) please see the documentation 
# located at http://www.splunk.com/base/Documentation/latest/Admin/HowDoConfigurationFilesWork.

[<TRANSACTIONTYPE>]
* Create any number of transaction types, each represented by a stanza name and any number of the following attribute/value pairs.
* Use the stanza name, [<TRANSACTIONTYPE>], to search for the transaction in Splunk Web.
* If you do not specify an entry for each of the following attributes, Splunk uses the default value.

maxspan = [<integer> s|m|h|d]
* Set the maximum time span for the transaction.
* Can be in seconds, minutes, hours or days.
 * For example:  5s, 6m, 12h or 30d.
* If there is no "pattern" set (below), defaults to 5m. Otherwise, defaults to -1 (unlimited).

maxpause = [<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.
* If there is no "pattern" set (below), defaults to 2s. Otherwise, defaults to -1 (unlimited).

maxrepeats = <integer>
* Set the maximum number of repeated event types to match against pattern (see below).
* For example, if maxrepeats is 10, and there are 100 events in a row, all with the same eventtype, only the first and last 10 are matched against pattern.
* A negative value means no limit on repeats, but can possibly cause memory problems.
* Defaults to 10.

fields = <comma-separated list of fields>
* If set, each event must have the same field(s) to be considered part of the same transaction.
* Defaults to "".

exclusive = <true | false>
* Toggle whether events can be in multiple transactions, or 'exclusive' to a single transaction.  
* Applies to 'fields' (above).
* For example, if fields=url,cookie, and exclusive=false, then an event with a 'cookie', but not a 'url' value could be in multiple transactions that share the same 'cookie', but have different URLs.
* Setting to 'false' causes the matcher to look for multiple matches for each event and approximately doubles the processing time.
* Defaults to "true".

aliases = <comma-separated list of alias=event_type>
* Define a short-hand alias for an eventtype to be used in pattern (below).
* For example, A=login, B=purchase, C=logout means "A" is equal to eventtype=login, "B" to "purchase", "C" to "logout".
* Defaults to "".

pattern = <regular expression-like pattern>
* Defines the pattern of event types in events making up the transaction.
* Uses aliases to refer to eventtypes.
* For example, "A, B*, C" means this transaction consists of a "login" event, followed by any number of "purchase" events, and followed by a "logout" event.
* You can also specify a group of events to be repeated: "A, (B, C)*, D".
* Defaults to "".

match = closest
* Specify the match type to use.
* Currently, the only value supported is "closest."
* Defaults to "closest."

transactiontypes.conf.example

# Copyright (C) 2005-2008 Splunk Inc.  All Rights Reserved.  Version 3.0
#
# This is an example transactiontypes.conf.  Use this file as a template to configure transactions types.
#
# To use one or more of these configurations, copy the configuration block into transactiontypes.conf 
# in $SPLUNK_HOME/etc/system/local/.
#
# To learn more about configuration files (including precedence) please see the documentation 
# located at http://www.splunk.com/doc/latest/admin/BundlesIntro.

[default]
maxspan = 5m
maxpause = 2s
match = closest

[purchase]
aliases  = A=login, B=purchase, C=logout
pattern  = A, B, C
maxspan  = 10m
maxpause = 5m
fields  = userid

This documentation applies to the following versions of Splunk: 3.3 , 3.3.1 , 3.3.2 , 3.3.3 , 3.3.4 , 3.4 , 3.4.1 , 3.4.2 , 3.4.3 , 3.4.5 , 3.4.6 , 3.4.8 , 3.4.9 , 3.4.10 , 3.4.11 , 3.4.12 , 3.4.13 , 3.4.14 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!