Purpose

This article explains how to enable logging in the Windows Hipchat client (4.0 and later) and how to send the logs to Hipchat Support.

Sometimes Hipchat Support needs additional information from the Hipchat client that is experiencing issues. Not all bugs are duplicatable, and oftentimes we can capture information that is helpful in troubleshooting and fixing bugs through logging.

Solution

Get the log file from your file system

Open up File Explorer and paste in the following path. The logs will be available in this directory:
%USERPROFILE%\AppData\Local\Atlassian\Hipchat\Logs

Enable logging

These steps are no longer required with the 4.28 client, since logging is enabled by default.  Adding --logtofile with this version will cause the app to not start.

When you enable logging, you can choose to make the log file accessible from your computer's file system.

1. Quit Hipchat. (Right-click the Hipchat icon in the system tray, then choose Quit.)
2. On your desktop, right-click the Hipchat shortcut icon and choose Properties.
3. In the Target field, add the following to the end of the line:
   • --logtofile to make the file accessible in your computer's file system
   • It looks like this:
     
     
4. When a message prompts you to provide administrator permission, click Continue.
5. Click OK.

If you don't have a Hipchat shortcut on your desktop:

1. Open a command prompt, change to the Hipchat install directory:
   cd C:\Program Files (x86)\Atlassian\HipChat4
2. Append --logtofile to the Hipchat executable:
   hipchat.exe --logtofile

Generate and send the log file

1. Log in to Hipchat and try to duplicate the behavior that you want to capture in the logs.
2. After the behavior happens, get the log file either from your file system.
3. Remove any sensitive data from the log file. (See What's included in the log?)
4. Add the log file to your Hipchat Support ticket.

What's included in the log? 

These logs will capture what the application is doing in the background. This helps Hipchat Support in finding, troubleshooting, and fixing bugs.

PLEASE NOTE: While most of the chat data will be removed from the logs, the logs could still have some history for open chats. If there is sensitive information, please go through the logs and check to make sure that the sensitive data is removed before sending them over to us.

Additional Hardware Information with DirectX Diagnostic Tool

Some issues may require additional information about your specific system's hardware configuration for us to troubleshoot. To gather this data, please use the DirectX Diagnostic Tool that is bundled with Windows.

1. Open DirectX Diagnostic Tool by clicking the Start button , type dxdiag in the Search box, and press ENTER.
2. Choose "Save All Information..." to save the resulting report.
3. Add the DirectX Diagnostic report to your Hipchat Support ticket.