Overview

Logging can be enabled in FogBugz On-Premises for the Website and for the Heartbeat Pinger service. We recommend enabling logging as described below only as a temporary troubleshooting aid. Disable these detailed loggings once troubleshooting is done, otherwise, the detailed logs might use up your disk space.

Audit Logging is available in Website logs since FogBugz On-Premises 8.21.919.

For logging in FogBugz 8.8.55 and below, please see the doc for logging with FogBugz For Your Server.

Prerequisites

• Administrator right on the Webserver running the FogBugz website

Solution

FogBugz On-Premises ships with a basic log4net configuration that will meet most of your temporary logging needs. Adjusting the verbosity and targets of the logs works as described in the official log4net documentation.

Website Logging

Website logging enables output for each and every web request handled by FogBugz.

Enable Website Logging

1. Navigate to [Your On-Premises installation directory]\installed-components\fogbugz\fogbugz_{version}\Website] folder
2. Edit logging.config
3. Locate the following appender: 

   <appender
       name="File"
       type="log4net.Appender.FileAppender">

4. Configure the log file location by editing the file value parameter of the appender. By default it is c:\logs\fogbugz.log

   <file value="c:\logs\fogbugz.log" />

5. Locate the the <root> node:
6. Uncomment the following appender-ref node under the <root> node by removing the <!-- and --> around it, so it looks like this:

    <appender-ref ref="File" />

7. Save the file.
8. Restart the IIS Server using the IIS Manager, or by issuing the iisreset command from a command prompt.
9. Verify that the website started to add new records to the configured log file.

Disable Website Logging

1. Navigate to [Your On-Premises installation directory]\installed-components\fogbugz\fogbugz_{version}\Website] folder
2. Edit logging.config
3. Locate the the <root> node:
4. Comment out the following appender-ref node under the <root> node by adding the <!-- and --> around it, so it looks like this: 

    <!-- <appender-ref ref="File" /> -->

5. Save the file.
6. Restart the IIS Server using the IIS Manager, or by issuing the iisreset command from a command prompt.
7. Verify that the website stopped adding records to the configured log file.

Back to the top

Audit Logs in Website Logging

Audit Log items are logged in the Website log file at "NOTICE" log level and prefixed with the string (AUDIT). Here is an example:

2020-10-28 15:02:50,646 NOTICE 7 FogBugz - -1:nukukub1f:0178.6109:0204.3434:(AUDIT) Modify User; Attempt; Administrator; 127.0.0.1; fogbugz.contoso.com; User account changes requested for ixPerson 5

Appender for filtering Audit Logs

If you would like to have the audit log items logged to a separate file you will need to add a new appender that is going to filter the "NOTICE" log level messages containing the string "(AUDIT)".

To add such an appender follow the steps below:

1. Navigate to [Your On-Premises installation directory]\installed-components\fogbugz\fogbugz_{version}\Website] folder
2. Edit logging.config
3. Add the following appender to the list of appenders:

   <!-- log only AUDIT logs -->
   <appender
         name="AuditLogToFile"
         type="log4net.Appender.FileAppender">
       
         <file value="c:\logs\fogbugz_audit.log" />
         <appendToFile value="true" />
         <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
       
         <layout type="log4net.Layout.PatternLayout">
         	<conversionPattern value="%utcdate %level %thread %logger - %message%newline"/>
         </layout>
         
         <!-- filter for AUDIT logs -->
         <filter type="log4net.Filter.LevelMatchFilter">
         	<levelToMatch value="NOTICE" />
         	<stringToMatch value="(AUDIT)" />
         </filter>
         
         <!-- do not log anything else to this file -->
         <filter type="log4net.Filter.DenyAllFilter" />
   </appender>

4. Configure the log file location by editing the file value parameter of the appender. By default it is c:\logs\fogbugz_audit.log

   <file value="c:\logs\fogbugz_audit.log" />

5. Add the appender to the appenders list by adding the following line to the <root> node (adding it by its name): 
   

   <appender-ref ref="AuditLogToFile" />

6. Save the file.
7. Restart the IIS Server using the IIS Manager, or by issuing the iisreset command from a command prompt.
8. Logout from FogBugz and log back in. This way audit log actions are generated.
9. Verify in the audit log file (in the example above c:\logs\fogbugz_audit.log) that your logout and login actions have been logged.

Logged Audit Log Actions

1. All successful login events and unsuccessful login attempts
2. All logoff events
3. This includes both events that occur when a user manually logs out, and events that occur when an administrator uses the Session Management page in Manuscript to terminate a session, delete a token, or kill all active sessions.
4. The creation, modification, and deletion of user accounts
5. The generation of a new API token during a user’s session
6. All attempts to perform unauthorized activities that result in a 403 error code

Logged Information per Action

1. The name of the action
2. The date and time of the action (in the format “YYYY-MM-DD HH:mm:ss”)
3. The name of the user (using the FogBugz field “sFullName”, which should contain both the first and last name of the user who is currently logged in) associated with the action
4. The outcome of the action
5. The action attempt will be logged as one line, and its success or failure will be logged as a separate line
6. In the case of a partial success of an action, the part of the action that succeeded and the parts of the action that failed will be logged in separate lines
7. The IP address associated with the action
8. The name of the system from which the action originated will also be logged, but only when the Reverse DNS lookup on the IP address succeeds; in the case of a Reverse DNS lookup failure, the name of the system will not be logged.

Back to the top

Heartbeat Pinger Logging

The Heartbeat Pinger ensures that periodic tasks in FogBugz (checking mail, firing Web Hooks, sending notifications, etc) are run. If these tasks aren’t working and website logging doesn’t indicate any problems, there might be a problem with the Heartbeat Pinger Service.

Enable FogBugz Heartbeat Pinger Logging

1. Navigate to [Your On-Premises installation directory]\installed-components\heartbeatpinger\heartbeatpinger_{version}
2. Edit logging.config
3. Locate the following appender: 

   <appender name="File" type="log4net.Appender.FileAppender">

4. Configure the log file location by editing the file value parameter of the appender. By default it is c:\logs\pinger.log

   <file value="c:\logs\pinger.log" />

5. Locate the the <root> node:
6. Uncomment the following appender-ref node under the <root> node by removing the <!-- and --> around it, so it looks like this:

    <appender-ref ref="File" />

7. Save the file.
8. Restart the FogBugz Heartbeat Pinger service using the Services Windows control panel.
   
   
9. Verify that the Heartbeat Pinger service started to add new records to the configured log file.

Disable Heartbeat Pinger Logging

1. Navigate to [Your On-Premises installation directory]\installed-components\heartbeatpinger\heartbeatpinger_{version}
2. Edit logging.config
3. Locate the the <root> node:
4. Comment out the following appender-ref node under the <root> node by adding the <!-- and --> around it, so it looks like this:
   

    <!-- <appender-ref ref="File" /> -->

5. Save the file.
6. Restart the FogBugz Heartbeat Pinger service using the Services Windows control panel.
7. Verify that the Heartbeat Pinger service stopped to add new records to the configured log file.

Back to the top