Log Workflow Execution in SVCLOG Trace Files

You can log workflow execution in SVCLOG trace files for diagnostic and debugging purposes. This logging feature is enabled for each execution engine, from its respective configuration file.

  • Administration site
  • Flowtime site
  • Background Runtime Service
  • Job Execution Service

The trace files are created in the path that you specify in the traceDirectory parameter in the configuration file. Generally, the path is C:\Program Files\PNMsoft\Shared Resources\RuntimeLogs.

IMPORTANT: Creating SVCLOG files consumes server resources, such as disk space and CPU time. We recommend that you enable this logging feature for a limited time, and closely monitor server performance.

Tips

  • If workflow execution is always enabled, for example, in development or testing environments, we recommend that you add add a scheduled task that deletes obsolete log files.
  • We recommend that you use the same path for the log files (this is not required).
  • Use a service trace viewer tool to open the SVCLOG trace files.
  • When you add the configuration sections to the config files, make sure you use the appropriate product version. If you have Sequence 7.x, use 7.0.0.0. If you have Sequence 8.x, use 8.0.0.0.

Enable SVCLOG Tracing

  1. Open the appropriate configuration file for the execution engine that you want to create SVCLOG trace files for.
  2. Edit the configuration file.
    1. Locate the relevant section (see the execution engine configuration files below).
    2. Remove the comment out syntax of these sections by removing <!-- and -->.
    3. Save the configuration file.
  3. (Optional) Restart the BRS if you edited the BRS configuration file.
    When you save a web.config file, the site automatically resets. You do not have to run IISReset.

Disable SVCLOG Tracing

  1. Open the appropriate configuration file for the execution engine that you want to disable SVCLOG tracing for.
  2. Edit the configuration file.
    1. Locate the relevant section (see the execution engine configuration files below).
    2. Add the comment out syntax of these sections by adding <!-- and -->.
    3. Save the configuration file.
  3. (Optional) Restart the BRS if you edited the BRS configuration file.
    When you save a web.config file, the site automatically resets. You do not have to run IISReset.

Runtime Web.config File

<system.diagnostics>
   ....
      <source name="sequence.runtime" switchName="SourceSwitch" switchType="System.Diagnostics.SourceSwitch">
         ....
          <!--<add name="RuntimeLog" traceDirectory="C:\Program Files\PNMsoft\Shared Resources\RuntimeLogs" type="PNMsoft.Sequence.Diagnostics.SvcFormatWorkflowRuntimeTraceListener, PNMsoft.Sequence, Version=7.0.0.0, Culture=neutral, PublicKeyToken=0a1a1b90c1c5dca1" />-->
        ....
   </source>
   ...

  </system.diagnostics>

Administration Web.config File

<system.diagnostics>
  ...
                  <!--<add name="RuntimeLog" type="PNMsoft.Sequence.Diagnostics.SvcFormatWorkflowRuntimeTraceListener, PNMsoft.Sequence, Version=7.0.0.0, Culture=neutral, PublicKeyToken=0a1a1b90c1c5dca1" traceDirectory="C:\Program Files\PNMsoft\Shared Resources\RuntimeLogs\" />-->
   ...
  </system.diagnostics>

Background Runtime Service Web.config File

Since the BRS is always on, the BRS SVCLOG files generally inflate quickly. Enable them for a limited time only. 

<system.diagnostics>
   ...
    <sources>
         ...
             <source name="sequence.runtime" switchName="sequence.runtime.switch" switchType="System.Diagnostics.SourceSwitch">
                <listeners>
                <remove name="Default" />
                <add name="EventLogListener" type="PNMsoft.Sequence.Diagnostics.EventLogTraceListenerEx, PNMsoft.Sequence, Version=7.0.0.0, Culture=neutral, PublicKeyToken=0a1a1b90c1c5dca1" initializeData="Panam">
                <filter type="System.Diagnostics.EventTypeFilter" initializeData="Error" />
                </add>
                <add name="BRS_RuntimeLog"
 type="PNMsoft.Sequence.Diagnostics.SvcFormatWorkflowRuntimeTraceListener, PNMsoft.Sequence, Version=7.0.0.0, Culture=neutral, PublicKeyToken=0a1a1b90c1c5dca1"
 traceDirectory="C:\Program Files\PNMsoft\Shared Resources\RuntimeLogs" />
                </listeners>
            </source>
         ...
    </sources>
   ...
 <switches>
   ...
  <add name="sequence.runtime.switch" value="All" />
   ...
 </switches>
</system.diagnostics>

Job Execution Service Web.config File

<system.diagnostics>
   ...
    <sources>
         ...
             <source name="sequence.runtime" switchName="sequence.runtime.switch" switchType="System.Diagnostics.SourceSwitch">
                <listeners>
                <remove name="Default" />
                <add name="EventLogListener" type="PNMsoft.Sequence.Diagnostics.EventLogTraceListenerEx, PNMsoft.Sequence, Version=7.0.0.0, Culture=neutral, PublicKeyToken=0a1a1b90c1c5dca1" initializeData="Panam">
                <filter type="System.Diagnostics.EventTypeFilter" initializeData="Error" />
                </add>
                <add name="JES_RuntimeLog"
 type="PNMsoft.Sequence.Diagnostics.SvcFormatWorkflowRuntimeTraceListener, PNMsoft.Sequence, Version=7.0.0.0, Culture=neutral, PublicKeyToken=0a1a1b90c1c5dca1"
 traceDirectory="C:\Program Files\PNMsoft\Shared Resources\RuntimeLogs" />
                </listeners>
            </source>
         ...
    </sources>
   ...
 <switches>
   ...
  <add name="sequence.runtime.switch" value="All" />
   ...
 </switches>
</system.diagnostics>
About this Article
  • Created: 06/12/2017 12:42 pm EDT
  • Last updated: 08/24/2017 6:18 am EDT
In This Article