Capturing C-Gate Logs

(Updated February 2014)

From time to time you may be asked to provide detailed C-Gate logs for diagnostic purposes.

C-Gate 2.10.0 and later

C-Gate by default will log at the maximum level - even if you have upgraded from an earlier version that logged at a lower level.

1. Reproduce the Problem. Make a note of the system time so we can locate the right segment in the logs.

4. Take a copy of the following three files:

C:\Clipsal\C-Gate2\config\C-GateConfig.txt
C:\Clipsal\C-Gate2\log\event.txt
C:\Clipsal\C-Gate2\exception.info
​

NOTE:

• 
  If the period you are trying to capture is very long you may need to include older log files as well. These files will have a name in the format: C:\Clipsal\C-Gate2\log\event-<date>-<index>.txt

5. Zip the files up in one archive and send to technical support or attach to your post on the forums.

For more information about configuring C-Gate logging, please read the C-Gate manual included in the C-Gate directory.


C-Gate 2.9.8 and earlier

C-Gate by default logs at Event Level 5.

1. Configure C-Gate to run at Event Level 9.

Locate the C-Gate config file. This is usually at:

C:\Clipsal\C-Gate2\config\C-GateConfig.txt

And make the following changes. First, change "no" to "yes" for this option (line in bold):

#### command.show-responses:
# show execution time events for commands
# Default Value: no
# Scope: global
# Effective on: restart
###
command.show-responses=yes

​

Then change the following value from 5 to 9 (line in bold):

#### global-event-level:
# Global event reporting level (events <= event level will be reported (range 0-9)
# Default Value: 5
# Scope: global
# Effective on: restart
###
global-event-level=9
​

Change the following value from no to yes (line in bold):

#### use-event-file:
# Save events to a file (filename specified in event-filename)
# Default Value: no
# Scope: global
# Effective on: restart
###
use-event-file=yes
​

And if the following value is 2000, change it to 5 million (line in bold). This was a bug that made it into a few releases:

#### event-file.split-size:
# Size in bytes at which to split the event-file
# Default Value: 5000000
# Scope: global
# Effective on: restart
###
event-file.split-size=5000000
​

And ensure the following value is 100:

event-file.split-count=100
​

And make a note of the following value (line in bold). This is where your log file will be saved, in the C:\Clipsal\C-Gate2 directory.

#### event-filename:
# Filename for the event log (if enabled by use-event-file)
# Default Value: event.log
# Scope: global
# Effective on: restart
###
event-filename=event.log
​

Now save the file. These changes will ensure you are producing the maximum logging in C-Gate.

2. Restart C-Gate, as well as Toolkit, S+, OPC etc if they were running.

3. Reproduce the Problem. Try to make a note of the clock time so we can find it in the logs more easily.

4. Take a copy of the following three files:

C:\Clipsal\C-Gate2\config\C-GateConfig.txt
C:\Clipsal\C-Gate2\event.log
C:\Clipsal\C-Gate2\exception.info
​

NOTE:

• 
  If the period you are trying to capture is very long you may need to include older log files as well. You can examine the timestamps to decide whether to include them:
  
  C:\Clipsal\C-Gate2\event.00.log
  C:\Clipsal\C-Gate2\event.01.log
  C:\Clipsal\C-Gate2\event.02.log ... etc.
  

5. Zip the files up in one archive and send to technical support or attach to your post on the forums.

6. On a production site you may wish to minimise logging again. Edit the C-Gate Config file again and reverse the above changes.