As Tealeaf builds and processes sessions, it derives data from the captured information that is applicable to the entire session. The following session-level fields can be searched:
Field | Description |
---|---|
Annotations |
Use this text field to enter search fields for the specific annotation note. Wildcards are accepted. An annotation value is indexed with the author's username, as described in the following field. |
Annotation Authors |
You can also search for the author of the annotation based on the author's username. |
Browser Type |
Search sessions by the type of browser, as identified by the user agent: Browser type data is populated only if extended user agent parsing is enabled in the Tealeaf Reference session agent deployed in your Windows™ pipeline. |
Client IP |
The IP address of the web browser that requested the page. This value rarely deviates from the IP address value for the session. |
First Page |
Search all sessions for a path that is also the first page of the session, for example |
Hit Count |
Search all sessions for any session with the number of hits that is more than, less than, equal to or not equal to the number you input. You can use the operators |
Last Page |
Search all sessions for a path that is also the last page of the session, for example |
Session Index |
The unique session ID assigned by Tealeaf. |
TLT Session ID |
Tealeaf can inject a session-specific cookie into the visitor's browser. This cookie simplifies grouping all hits related to a specific session if no other common session key is available. |
User ID |
(Completed sessions only) A Tealeaf cookie injector can be installed on your web servers and configured to insert a unique, permanent cookie into the browser of each visitor. This cookie's value is automatically added to the session data. |
IP address search
Tealeaf supports the ability to capture, store, and search for IP addresses that are specified in IPv4 format or IPv6 format.
The IPv4 format is prevalent on the Internet for many years, while the IPv6 format was designed to replace IPv4 by offering potentially many more possible addresses.
IP address data is inserted by the CX Passive Capture Application into the [env]
section of the request. The fields that are defined in your search templates can be configured to scan for the presence of this request data. Tealeaf provides search terms in the default templates to search for IP addresses, including the client IP, server IP, and more.
IP addresses in either format can be inserted into any search field that is specified to search for this data.
In the available default templates, IP address specification applies to Session
Info\Client IP
and Page Info\Server IP
. For more information about searching:
Text in Request
field to search for IP addresses, the address must be inserted without periods (AAABBBCCCDDD
).IPv4 and IPv6 address are valid IP address formats.
You can use wildcards in any octet (IPv4) or group (IPv6).
Wildcard | IPv4 support | IPv6 support |
---|---|---|
* |
See IPv6 support column. | The asterisk (* ) can be used to replace one or more groups.
Note: You cannot use the asterisk as part of a specified group or octet (for example,
4* as an entry for a group or octet is not allowed). |
? |
Wildcards for single characters are not supported. | Not supported |
In an IPv4 address, a range can be specified in a single octet as:
100-199
For IPv6 address, a range can be specified in one or more groups as:
0000-1000
IPv6 Limitations: none
IPv4 Limitations:
- You can specify a range in only one of the octets.
- If multiple ranges are specified in a single octet, then the IP address is ignored.
- If multiple octets each contain ranges, then the IP address is ignored.
- Wildcards can not be included in octet ranges. For example, an IP address with an octet such as
CCC-D*
is ignored when the search is run.
Examples for IPv4:
IP address | Works | Explanation |
---|---|---|
1.12.113.114 |
Y | A valid entry |
1.?2.113.114 |
Y | Not supported |
1-99.22.113.114 |
Y | Returns all matching IP addresses whose first octet a value between 1 and 99 inclusive. |
In most web applications, the client IP address is contained in the REMOTE_ADDR
field in the request.
- Tealeaf provides the search field
Session Info\Client IP
in the default completed template, which is configured to search for the client IP address, provided it is displayed inREMOTE_ADDR
. - This value is the raw, non-normalized remote address.
- If this value is an IPv6 address, the
REMOTE_ADDR
contains the IPv6 value in compressed format, if compression is enabled in the PCA.
If the Client IP search field is not available, the client IP address can be available in the [env]
or [appdata]
section of the request, depending on the rules that are configured for your Windows pipeline.
- If it is an IPv6 address, the value is stored in the
[env]
section of the request and can be in compressed format, as captured and processed by the PCA.Note: If your web infrastructure uses a proxy, such as Akamai, in front of your web servers or if your network traffic is passed through a Network Address Table, theREMOTE_ADDR
field does not contain the true client IP address. In these configurations, you must review the request headers for a special label such asHTTP_X_FORWARDING
, which contains the true client IP.The CX Passive Capture Application can be configured to use the
HTTP_X_FORWARDING
setting for populating theREMOTE_ADDR
value.
Searching for IPv4 addresses
In Active, Completed, or All Session searches, you can search for IP addresses in IPv4 format for the visitor's client or your web servers.
For fields identified as an IP address, you can search for IPv4 addresses as a set of four octet values.
To search for IPv4 addresses:
- From the Session Info panel, click Client IP.
The search field for Client IP is displayed in the Search Configuration window.
- In the text field, enter the IP address in the following format:
AAA.BBB.CCC.DDD
Note: IPv4 addresses entered in the following formats are not supported for search:AAA BBB CCC DDD AAABBBCCCDDD
- Click Search.
Searching for IPv6 addresses
You can search for IP addresses in IPv6 format for the visitor's client or your web servers.
<env>
section of the request.
To search for IPv6 addresses:
- From the Session Info panel, click Client IP.
The search field for Client IP is displayed in the Search Configuration window.
- In the text field, enter the IP address
For IPv6 addresses, you may enter the address in the provided IP address field in either uncompressed or compressed format.
Note: In IPv6 notation, the port number may be appended to the address in parentheses:(8080)
. In Tealeaf, searches using port numbers are not supported.Note: You cannot search for full, compressed IPv6 addresses. You must apply wildcards to the search string.In compressed format, the above address can be entered as follows:
2001:db8:85a3:0:0:8a2e:370:7334
The compressed address is expanded as part of the submitted query.
Wildcards and ranges may be applied to IPv6 addresses.
- Click Search.
Searching for IP addresses in free text
You can use the freetext search field to specify an IP address by using wildcards. However, since this search method is run against all applicable fields, results are returned at a slower rate.
Tealeaf captures IP addresses in active session data in their native form. After a session is complete, IP addresses are turned into 12-digit values so they can be easily indexed. For example, the IP address 192.168.0.1
in an active session is rendered into the following value that is stored with the completed session data: 192168000001
.
Depending on the type of search, you must specify a free-text search of an IP address in either of the following ways:
- Active Sessions: For active sessions, you can specify the full IP address, by using wildcards. In the previous example, search for
192.168.*.1
matches the above IP address and all other IP addresses whose first, second, and fourth field is the same. - Completed Sessions: For completed sessions, the IP address is now stored as a 12-digit text string, so wildcards do not apply. Full IP addresses must be supplied. For example, the value
192168000001
for an IP address in a completed session is not equivalent to 192,168,000,001.Storing as a numerical value enables searching across ranges of IP addresses.
Searching for annotations
You can search for annotations that are added to session data through Tealeaf.
Annotations provide a mechanism for tracking activities by Tealeaf users about individual sessions. Annotation data is stored with the session data.
After an annotation is saved into a session, the session must be indexed or re-indexed before the annotation is available through search. You cannot search for annotations in active sessions. You can search for annotations through RTV.
To search for annotations:
- When a search template includes annotations, you can search for either the annotation or the author in the Session Info node.
Note: You cannot create searches for these fields in combination with other search fields. Annotations and Annotation Authors are indexed through a different document mechanism, which results in null search results when combined with other search fields.
- Optional: Search for annotations using the free-text search.
If your search templates do not include the Annotations and Annotation Authors search fields, you can still search for this data by using free text search.
You must enter the appropriate search keyword for these search items in the text field. Examples:
- Searching for annotation text:
annoobject/text contains error
Previous searches for annotations whose text contains
error
. - Searching for annotation author:
annoobject/name contains ADMIN
Previous searches for annotations whose author has the Tealeaf user ID
ADMIN
.
If you find yourself frequently using free-text search for annotations, your Tealeaf administrator can add the annotation fields to your search template. The keywords to add are
Annotations
andAnnotation Authors
, and MD5 hashing does not apply. - Searching for annotation text: