Windows Service Logging

Windows Service Configuration File

The "Management Server" windows service configuration file with a default installation is located here: "C:\Program Files\NovaStor\NovaBACKUP Central Management Console\Service\ManagementServer.Service.WindowsServiceHost.exe.config"

When this file is modified, the internal services will automatically restart and use the latest changes.

If the configuration file contains errors, the windows service will not start.

If the windows service is already started, it will automatically stop.

Log File Location

With a default installation, the log files are located here: "C:\Program Files\NovaStor\NovaBACKUP Central Management Console\Service\Logs"

How to enable logging for the "Management Server" windows service

Open the main "Management Server" windows service configuration file, unless otherwise specified, perform the steps outlined below, and then save the file. This generates a fairly large amount of trace data in the Logs directory.

Enable Log Listeners

Enable logging to the Application Event Log and a Flat File.

Change this: XML

<configuration>
  ...
  <loggingConfiguration ...>
    ...
    <categorySources>
      <add switchValue="All" name="General" />
    </categorySources>
  ...

to: XML

<configuration>
  ...
  <loggingConfiguration ...>
    ...
    <categorySources>
      <add switchValue="All" name="General" >
        <listeners>
          <add name="Event Log Listener" />
          <add name="Flat File Trace Listener" />
        </listeners>
      </add>
    </categorySources>
  ...

Errors will now be logged in the trace.log file in the Logs directory by default.

Enable WCF Verbose Activity Tracing

For communication issues bet, Set the switchValue attributes to Verbose, ActivityTracing.

Change this: XML

<configuration>
  ...
  <system.diagnostics>
      <sources>
        <source name="System.ServiceModel" switchValue="Warning" propagateActivity="true">
        ...
        <source name="System.ServiceModel.MessageLogging" switchValue="Warning">
    ...

to: XML

<configuration>
  ...
  <system.diagnostics>
      <sources>
        <source name="System.ServiceModel" switchValue="Verbose, ActivityTracing" propagateActivity="true">
        ...
        <source name="System.ServiceModel.MessageLogging" switchValue="Verbose, ActivityTracing">
    ...

Errors will now be logged in app_tracelog.svclog and app_messages.svclog files in the Logs directory by default.

Enable Message Logging

Open "system.serviceModel.diagnostics.config" and enable logMessagesAtServiceLevel, logMalformedMessages, and logMessagesAtTransportLevel.

Change this: XML

<configuration>
  ...
  <system.serviceModel>
    ...
      <diagnostics>
      <messageLogging logMessagesAtServiceLevel="false" logMalformedMessages="false" logMessagesAtTransportLevel="false"  />
    ...

to: XML

<configuration>
  ...
  <system.serviceModel>
    ...
      <diagnostics>
      <messageLogging logMessagesAtServiceLevel="true" logMalformedMessages="true" logMessagesAtTransportLevel="true" />
    ...

Enable Message Logging with Personally Identifiable Information

For example, this logs the remote IP address of clients connecting to the service.

Open "C:\Windows\Microsoft.NET\Framework\v4.0.30319\Config\machine.config" and set enableLoggingKnownPii.

Change this: XML

<configuration>
  ...
  <system.serviceModel>
    ...
      <machineSettings enableLoggingKnownPii="false" />
    ...

to: XML

<configuration>
  ...
  <system.serviceModel>
    ...
      <machineSettings enableLoggingKnownPii="true" />
    ...

Open "system.serviceModel.diagnostics.config" and enable logMessagesAtServiceLevel, logMalformedMessages, logMessagesAtTransportLevel, logEntireMessage, and logKnwonPii.

Change this: XML

<configuration>
  ...
  <system.serviceModel>
    ...
      <diagnostics>
      <messageLogging logMessagesAtServiceLevel="false" logMalformedMessages="false" logMessagesAtTransportLevel="false"  />
    ...

to: XML

<configuration>
  ...
  <system.serviceModel>
    ...
      <diagnostics>
      <messageLogging logMessagesAtServiceLevel="true" logMalformedMessages="true" logMessagesAtTransportLevel="true" logEntireMessage="true" logKnwonPii="true" />
    ...