Settings — Logs
Settings — Logs
The log properties are used to define the communication and persistence settings for:
Event Log Settings
OPC Diagnostics Log Settings
Communications Diagnostics Log Settings
ThingWorx Diagnostics Log Settings
Audit Log Settings
 
Connection
 
Port: Specify the TCP/IP port to be used to communicate between the logs and the application. The valid range is 49152 to 65535. To restore the default port setting, enter a blank value.
 
 
Log Settings
 
The properties for each log type are the same, but the values you set are independent for each log type.
 
 
Persistence Mode: icon to open the log's persistence mode. Options include Memory, Single File, and Extended Datastore. The default setting for the Event Log Setting and Audit Log Setting is Single File. The default setting for Communications Diagnostics Log Settings is Memory (no persistence). The default setting for OPC Diagnostics Log Settings is Single File. The default setting for ThingWorx Diagnostics Log settings is Single File. Descriptions of the options are as follows:
Memory (no persistence): When selected, this mode records all events in memory and does not generate a disk log. A specified number of records are retained before the oldest records start being deleted. The contents are removed each time the server is started.
Single File: When selected, this mode generates a single disk-based log file. A specified number of records are retained before the oldest records start being deleted. The contents are restored from this file on disk when the server is started.
Extended Data Store: When selected, this mode persists a potentially large number of records to disk in a data store distributed across many files. The records are retained for a specified number of days before being removed from the disk. The contents are restored from the distributed file store on disk when the server is started.
Max. records: Specify the number of records that the log system retains before the oldest records start being deleted. It is only available when the Persistence Mode is set to Memory or Single File. The valid range is 100 to 100,000 records. The default setting is 25,000 records.  Note:  The log is truncated if this property is set to a value less than the current size of the log.
 
Log file path: Specify where the disk log is stored. It is only available when the Persistence Mode is set to Single File or Extended Datastore. Note: Attempts to persist diagnostics data using a mapped path may fail because the Event Log service is running in the context of the SYSTEM account and does not have access to a mapped drive on the local host. Users that utilize a mapped path do so at their own discretion. It is recommended that the Uniform Naming Convention (UNC) path be used instead.
 
Max. single file size: Specify the size that a single datastore file must attain before a new datastore file can be started. It is only available when the Persistence Mode is set to Extended Datastore. The valid range is 100 to 10000 KB. The default setting is 1000 KB.
 
Min. days to preserve: Specify that individual datastore files are deleted from disk when the most recent record stored in the file is at least this number of days old. It is only available when the Persistence Mode is set to Extended Datastore. The valid range is 1 to 90 days. The default setting is 30 days.
 See Also:  Built-In Diagnostics
  When saving to file, monitor the Windows Event Viewer for errors relating to the persistence of data to disk.
 
 
Restoring Persisted Datastores from Disk
 
The Event Log restores records from disk either at start up or when the following occurs:
1. The Persistence Mode is set to Single File or Extended Datastore.   Note:  When Single File persistence is selected, the server loads all persisted records from disk before making any records available to clients.
2. The log file path is set to a directory that contains valid persisted log data.
 
Extended Datastore Persistence
 
The Extended Datastore Persistence Mode has the potential to load a very large number of records from disk. To remain responsive, the log services client requests for records while records are loaded from disk. As the record store is loaded, clients are provided with all records in the log regardless of filtering. Once all the records have been loaded, the server applies filters and sorts the records chronologically. The client views are updated automatically.
 Note:  Loading large record stores may cause the log server to be less responsive than usual. It regains full responsiveness once the loading and processing completes. Resource usage is higher than usual during loading and settles on completion.
 
 
Disk Full Behavior
 
The Extended Datastore Persistence Mode has the potential to fill a storage medium quickly, especially when persisting OPC Diagnostics. If a disk error is encountered while persisting records, an error posts to the Windows Event Viewer.
  See Also PC Diagnostics Viewer
 The Event Log system would be useless if there was no mechanism to protect its contents. If operators could change these properties or reset the log, the purpose would be lost. Utilize the User Manager to limit what functions an operator can access.
 
Was this helpful?