Loading...

Help for GxTail Dialog Boxes

This page provides decriptions of fields and options that are not self-evident in GxTail dialog boxes.

Add Profile

Use this dialog box to add a new Marker Profile.

Profile Name

Enter the name of a profile in which to save the currently defined marker setup information.

Customize

The Customize dialog box provides the tabs listed below, for configuring how GxTail looks and behaves. The preview pane at the bottom of this dialog box shows the result of your changes before you apply them.

Appearance Tab

The settings on this tab customize how GxTail presents log file data. You can set the font face and size, text foreground and background colors and more. See the steps in Changing the Look of GxTail.

Scroll Width

The maximum number of characters of log message text that GxTail will display on a single line.

Text

The default color scheme of message text (that is, how text looks if it has not had any other setting, or effect such as highlighting, applied to it). Note that pressing I inverts this scheme for the open tab.

Selected Text

The default color scheme for message text that is selected in the log window.

Caret Line

Sets the highlighting that appears on the message that currently contains the insertion bar. Clear the Visible option to turn it off. Click Color to change the color.

Reset

Sets the parameters in this dialog box to their factory default settings.

Apply

Sets the active tab to the appearance defined in the dialog box.

Apply All

Sets all open tabs to the appearance defined in the dialog box.

Email Tab

Before you can use GxTail's capability of sending filtered log message data to email users, the email service must be configured using the settings on this tab.

SMTP Server

The name of an outgoing SMTP-protocol mail service to which the computer running GxTail has access and through which it has authority to send email messages.

Server Port

The port number on the outgoing SMTP-protocol mail service named in SMTP Server.

From Address

The address that will appear in the From field of emails sent from GxTail.

To Address

The addresses to which emails are sent from GxTail if you click Send Email Test. Separate multiple addresses with commas.

Send Email Test

Click this to send a test email to the addresses configured in the To Address box above.

File Association Tab

Use this tab to set associations between types of files, such as .log, that will open in GxTail if double-clicked in Windows.

Extension

Enter a file extension here, or click the down-arrow and select an extension from the list.

Add

Places the file extension shown in the Extension box into the list of configured extensions below it.

Remove

Removes the file extension selected in the list of configured extensions.

Marker Properties Tab

Use this dialog box for setting the detailed properties of each of the 20 available markers. Open it by pressing CTRL+M.

Profile

Click this list and select an existing marker profile to read into GxTail. Note that when you load a profile, all the markers defined in that profile are loaded, not just the one currently displayed in the Marker box.

Load

Click this to load the Profile you selected.

Marker

Click this list and select a marker to configure.

Clear

Click to reset the properties for the marker you selected from the Marker list.

Clear All

Click to reset the properties for all GxTail markers.

Marker Text

Enter the string or regular expression to use for highlighting. If you enter a regular expression, be sure to select the Regular Expression option.

Fg Color

Click to set the color of text as it appears in message text to which this marker applies.

Bk Color

Click to set the color of the background behind the message text to which this marker applies.

Options

  • Mark Line

    This option highlights the entire line in which the text that matched the criteria was found (not just the matched text).

  • Regular Expression

    This option tells GxTail to interpret the Marker Text you entered as a regular expression, rather than a simple string.

  • Mark New Lines Only

    If you select this option, GxTail applies the marker only to lines that get added to the log file when you are not working offline.

  • Inactivity Alert

    If you select this option, when the amount of inactivity set in the Qty Seconds Inactivity Triggers Alert box is reached, GxTail sends an alert email to the account that is configured. (See Configuring Email Services).

Email Notification (Alert)

  • Enable

    Select this option to send alert email messages to the address configured when the marker is applied.  (See Configuring Email Services).

  • Send Once

    If you have selected the Enable option for email notification, select Send Once, and GxTail sends only one email even if it finds more than one occurrence of the Marker Text.

  • Setup Email

    Click to open the View > Customize > Email dialog box, so you can configure the email service.

Trigger Script or Binary (Alert)

  • Click this to select the script or binary executable to run when the marker criteria are met.

  • Enable

    Select this option to run the selected script or binary executable when the marker criteria are met.

  • Trigger Once

    If you have selected the Enable option for Trigger Script or Binary (Alert), select Send Once, and GxTail runs the program only one time even if it finds more than one occurrence of the Marker Text.

Qty Seconds Inactivity Triggers Alert

Enter a number of seconds here if you want GxTail to send an alert email and/or trigger the alert script or binary, if no new information is added to the any open log file within this time period. Be sure to also select Inactivity Alert. Note: This feature requires that either Email Notification or Trigger Script or Binary (or both) be enabled.

Filter Properties

Use this dialog box for setting the properties GxTail uses to show or hide messages in log files. Open it by pressing CTRL+F5.

Enable Filter

If you select this option, GxTail filters messages according to the criteria you define in this dialog box. If you clear this option, your filtering information is saved for future use, but not applied. (This option performs the same function as the Edit > Enable Filter command.)

Process ID

Enter a process ID number here to filter on it. (See Log Message Layout.)

Thread ID

Enter a thread ID number here (in hexadecimal format) to filter on it. It is not necessary to precede the number with "0x". (See Log Message Layout.)

Job ID

Enter a Job ID number here to filter on it. (See Log Message Layoutt.)

Include Containing String

A string or regular expression that a message must contain, for it to continue appearing after you apply the filter. Click the down arrow to select a string or regular expression from a list of those recently used. If you use a regular expression, be sure to select the Regular Expression option.

Exclude Containing String

A string or regular expression that a message must not contain, for it to continue appearing after you apply the filter. Click the down arrow to select a string or regular expression from a list of those recently used. If you use a regular expression, be sure to select the Regular Expression option.

Options

  • Regular Expression

    Select this option if you want GxTail to interpret the strings you entered as regular expressions. Applies to both the Include Containing String and the Exclude Containing String.

  • Regex Help

    Click to open the Regular Expression Builder to help when creating regular expressions.

  • Split Multiple Inclusive/Exclusive Strings

    Selecting this option tells the filter process to honor the character specified in OR Separator as separating multiple strings.

  • AND Inclusive Filter Enabled

    Selecting this option tells the filter process to honor the character specified in AND Separator as separating multiple strings.

  • OR Separator

    Enter the character here that you want recognized in your Include and Exclude strings as a "logical or" operator. Default is the pipe character, |.

  • AND Separator

    Enter the character here that you want recognized in your Include and Exclude strings as a "logical and" operator. Default is the ampersand character, "&". Requires that the AND Inclusive Filter Enabled option be selected.

Save Filtered Lines to File

Enter a file name here, and the messages in the active tab that meet the criteria are automatically saved to this file. Click the button to locate an existing file or folder in which to save the lines.

Copy the filtered lines to the clipboard

Select this option, and the messages in the active tab that meet the criteria are placed onto the clipboard so they can be pasted into another application.

Find

Use this dialog box for finding text in open files. Open it by pressing CTRL+F.

Find What

The string or regular expression that GxTail should match on. Click the down arrow to select a string or regular expression from a list of those recently used. If you use a regular expression, be sure to select the Regular Expression option.

Count All

Click this to receive a count of occurrences of the string or regular expression.

Options

  • All Files

    Select this option to find occurrences of the string or regular expression in all open files, not just the active one.

  • Regular Exp

    Select this option to have GxTail interpret the search criteria you entered in Find What as a complex expression. Under this option, you can select one of these sub-options:

    • Regular Exp

      Interpret the criteria as a regular expression.

    • File Wildcard

      Use * for any number of any characters, ? for one character.

    • SQL Wildcard

      Use % for any number of any characters, _ for one character.

    • Simple Exp

      Use textual operators to show logical relationship between strings (and, or, not and but are supported). Escape clauses are not supported. If you need to search for one of these operators as text, just enter a plain string in Find What, and clear this option.

    • STD Regex (a regular expression using the new C++ standard)

      Notes:

      • A full description of Regular Expression (Regex) usage is beyond the scope of this documentation, but the Regular Expression Builder is available by pressing CTRL+R.
      • Default regular expressions (the Regular Exp option) use the Scintilla interface, which does not support some modern syntax. However, in general, the Scintilla regular expression interface gives better performance.
      • The STD Regex option supports most modern syntax, but is generally slower.
  • Highlight

    Select this option to have GxTail highlight each occurrence of the string or regular expression that it finds, one by one as you go through the file.

Find Text in Files

Use this dialog box to find message text in files that are accessible on storage. Open it by pressing SHIFT+CTRL+F.

Look In

The path in which to perform the find operation. Prepopulates with the path to the current active file. Change as required by entering a new path or clicking .

File Ext's

The file types on which to perform the find operation. Prepopulates with the *.log. Change as required by entering a new type in the format, *.type. Separate multiple types with the pipe character, |.

Look for Text

Prepopulates with the currently selected text, or the previously used value if no text is selected. Change as required by entering a new type in the format, *.type. Separate multiple types with the pipe character, |.

Match Options

Select the expression type option to specify the format of your Look for Text field. Options include:

  • Regular Exp

    Interpret the criteria in Look for Text as a regular expression.

  • File Wildcard

    Select this to use * for any number of any characters, and ? for one character.

  • SQL Wildcard

    Select this to use % for any number of any characters, and _ for one character.

Open File Options

Select options for processing the files once the specified message text is found in them. Options include:

  • Bookmark All

    Select this option, and GxTail sets a bookmark on the first line containing the text that matched your criteria, in each file that opens.

  • Color

    Select a marker number from this list. The color associated with that marker is applied to the text that matches the Look for Text criteria.

  • Auto Open

    If you select this, GxTail opens each file that has matching text.

  • Close All Tabs

    Select this to have GxTail close all open files before opening the ones it finds, when the Auto Open option is selected.

  • Max Open

    If you select Auto Open, this option limits the number of files that GxTail will open automatically. If more files than this number have text that matches the criteria, only the first files found are opened, up to this number.

  • Manual

    Select this option to see a list of the files in which the specified message text is found, without actually opening any files.

  • Results

    This box displays a list of files in which the specified text was found. Double-click a file to open it in GxTail.

Search

Click this to perform the search after you set the parameters.

Reset

Click this to reset the options in this dialog box. This does not clear the actual search criteria.

Marker Properties

Use this dialog box for setting the detailed properties of each of the 20 available markers. Open it by pressing CTRL+M.

Profile

Click this list and select an existing marker profile to read into GxTail. Note that when you load a profile, all the markers defined in that profile are loaded, not just the one currently displayed in the Marker box.

Load

Click this to load the Profile you selected.

Marker

Click this list and select a marker to configure.

Clear

Click to reset the properties for the marker you selected from the Marker list.

Clear All

Click to reset the properties for all GxTail markers.

Marker Text

Enter the string or regular expression to use for highlighting. If you enter a regular expression, be sure to select the Regular Expression option.

Fg Color

Click to set the color of text as it appears in message text to which this marker applies.

Bk Color

Click to set the color of the background behind the message text to which this marker applies.

Options

  • Mark Line

    This option highlights the entire line in which the text that matched the criteria was found (not just the matched text).

  • Regular Expression

    This option tells GxTail to interpret the Marker Text you entered as a regular expression, rather than a simple string.

  • Mark New Lines Only

    If you select this option, GxTail applies the marker only to lines that get added to the log file when you are not working offline.

  • Inactivity Alert

    If you select this option, when the amount of inactivity set in the Qty Seconds Inactivity Triggers Alert box is reached, GxTail sends an alert email to the account that is configured. (See Configuring Email Services).

Email Notification (Alert)

  • Enable

    Select this option to send alert email messages to the address configured when the marker is applied.  (See Configuring Email Services).

  • Send Once

    If you have selected the Enable option for email notification, select Send Once, and GxTail sends only one email even if it finds more than one occurrence of the Marker Text.

  • Set Up Email

    Click to open the View > Customize > Email dialog box, so you can configure the email service.

Trigger Script or Binary (Alert)

  • Click this to select the script or binary executable to run when the marker criteria are met.

  • Enable

    Select this option to run the selected script or binary executable when the marker criteria are met.

  • Trigger Once

    If you have selected the Enable option for Trigger Script or Binary (Alert), select Send Once, and GxTail runs the program only one time even if it finds more than one occurrence of the Marker Text.

Qty Seconds Inactivity Triggers Alert

Enter a number of seconds here if you want GxTail to send an alert email and/or trigger the alert script or binary, if no new information is added to the any open log file within this time period. Be sure to also select Inactivity Alert. Note: This feature requires that either Email Notification or Trigger Script or Binary (or both) be enabled.

Markers and Filter

Use this dialog box for setting marker search criteria and message filtering criteria. Open it by pressing F9. (To set detailed marker properies, press CTRL+M.)

Clear All

Click to clear marker and filter criteria from this page.

Inverse Colors

Click to swap the foreground and background colors for all 20 markers.

Advance Marker

Click to open the Marker Properties dialog box, for setting detailed properties for each marker.

Regex Help

Click to open the Regular Expression Builder to assist you in creating regular expressions.

Add Profile

Click to open the Add Profile dialog box. In the Profile Name box, enter a name for the current collection of marker properties for all 20 markers and click OK.

Markers [1-n]

Enter a find string for each marker. Make sure the Regular Expression option on the Marker Properties dialog box is selected as required for that marker.

Only show lines containing this

Enter a string or regular expression to use when filtering for text that a message does contain.

Don't show lines containing this

Enter a string or regular expression to use when filtering for text that a message does not contain.

Enable Include and Exclude Filters

Select this option to enforce the filters defined in this dialog box. Clearing it allows you to turn filtering off without losing the definitions of the filters.

Apply

Click to apply the contents of this dialog box without closing it.

Regular Expression Builder

Use this tool to help when creating regular expressions when setting marker search criteria and message filtering criteria. The Test Target Text box reflects the effects of your expression as you build it. The Regular Expression Builder is also helpful when unit testing and teaching regular expressions.

Expression

Enter any starting text for your regular expression here. The expression you build using the components provided by the Regular Expression Builder tool appear in this box, so you can copy it to your search criteria box.

Ignore Case

Select this option to precede your regular expression with the code that ignores the upper- and lower-case status of characters it matches.

Convert SQL Wildcards to Regex

If you have entered SQL wildcards (% for any number of characters, _ for one character) in a regular expression, select this option to have them interpreted correctly.

Convert FileSystem Wildcards to Regex

If you have entered file system wildcards (* for any number of characters, ? for one character) in a regular expression, select this option to have them interpreted correctly.

(Regular Expression Type) Boost Regex, etc.

Select the supported regular expression extensions you are using.

Insert Token

Locate a token from the list, and double click its description to insert that token into the Expression box at the insertion point.

Replace With

Enter text to take the place of the text that matches the Expression. Remember that GxTail does not have the ability to change log file content, so this is strictly a test of what you would see if replace functionality were available.

Replace

Click to test replace functionality.

Undo

Click to reverse the replacement just made using the Replace button.

Test Target Text

The text in this box reflects the effects of your regular expression as you build it. You can paste your own text into this box for testing purposes.

Profile based Filter

Use this dialog box to read one or more saved profiles into GxTail, which can be helpful when troubleshooting an issue of a type you have seen before.

Folder Path

Enter the path to the folder that contains the profile you want to load.

Profile Name

Enter the profile names to load.  Separate multiple profile names with commas.

File Names

Enter the start of a file name. GxTail terminates the name with an implied 'any characters' wildcard. For example, if you enter CVD, filtering infers CVD*.*, which also works to match all log files of that type that have iteration numbers (such as CVD_1.log and CVD_2.log). Separate multiple file names with commas.

Last modified: 3/8/2018 7:47:44 PM