Skip to end of metadata
Go to start of metadata

Overview

Indigo includes a Data Logging feature to capture data as it is received to a persisted log file. 
The data is actively written to the log file so that in the event of a power outage or computer reboot all the data received is already recorded and nothing is lost.  

Screencast

 A screencast of the data logging process is available. Click here to see the video.

Data Logging Configuration

When you enable Pass Mode, the following Pass Mode Configuration editor will be displayed.

The Data Logging feature includes the following configuration options:

SettingDescription
Header / Footer
Include Log File Description HeaderIf this option is enabled, Indigo will include a header comment with date and time information in the log file when logging starts.
Include Log File Description FooterIf this option is enabled, Indigo will include a footer comment with date and time information in the log file when the logging is stopped or the session is closed.
Raw Data
Log Raw Data (No Formatting)If this option is enabled, Indigo will not attempt to determine line separation or add any formatting to the log file. The exact data received will be faithfully recorded to the log file as-is. 
Start New Log File
Allow Log file to grow continuouslyIf this option is enabled, Indigo will constantly log data to a single log file as long as the session is open.
Start new log file on date changeIf this option is enabled, Indigo will start new recording to a new log file when the date changes.
This is useful when recording data over multiple days and you want to break up the logging data into multiple files.
Start new log file after number of bytes receivedIf this option is enabled, Indigo will start new recording to a new log file after a log file reaches the specified number of bytes.
This is useful when recording data over time and you want to break up the logging data into multiple manageable sized files.
Bytes ReceivedThis option is only used when the logging is configured to start a new log file after a number of bytes have been received.
This field is used to specify the maximum number of bytes in each file. This is essence determines the maximum file size. 
Auto clear screen buffered data upon new log fileIf this option is enabled, Indigo will clear the data from the terminal session window when a new log file is started.
This option is highly recommended when logging large amounts of data to prevent Indigo from consuming too much system memory.  
Auto start logging when session is openedIf this option is enabled, Indigo will automatically start logging when the session file is opened.
The existing logging configuration option will be applied. 
Log Timestamp
Include time stamp on each log data line

If this option is enabled, Indigo will record a time stamp for each line of data received and logged.

This option should not be used if the terminal session was already configured to include a timestamp in the session data window.

Timestamp format string

This option specifies the timestamp string format to use when recording timestamps to the log file.

hh - hours
mm - minutes
ss - seconds
fff - milliseconds 

Timestamp line detection

Not all devices/hosts conform to a single line termination standard, therefore it may be necessary to define the line termination characteristics of the connection.

The following options are available:

  • Each line as displayed in the session data window (Default)
  • Each line ends with a <CR> 0x0D character
  • Each line ends with a <LF> 0x0A character
  • Each line ends with a custom character
  • Each line is separated based on the received data packet
Custom line delimiter

If the timestamp line detection property is configured to use the: Each line ends with a custom character option, then this field defines the line termination character.

Log File
Log file pathThis field defines the directory and file name for the data log file.

Session Status Icon

When a terminal session is actively logging data to a file, the following status icon will be displayed. 

Logging

This icon is displayed when the session data is being actively logged to a file.
Click the icon to display additional logging options or to stop logging.  
 

Session Menu

You can activate Session Data Logging from the Session Menu.

Session Toolbar

You can activate Session Data Logging from the session toolbar.

Session Context Menu

You can activate Session Data Logging feature from the session right-click context menu.

Internal Command

You can activate/deactivate Session Data Logging feature using the Internal Command syntax.

ExampleStart/stop session data logging
Command:log