Sharing YouTrack Diagnostic Files

To help us investigate a reported issue more efficiently, we may ask you to send YouTrack log files, a database archive, configuration files, or a capture of browser network records. Below, you can find information about gathering and submitting these files.

Instructions for retrieving log, database, and conf files are only relevant for YouTrack Server installations hosted on your own servers. If you use YouTrack Cloud, you can just share your instance name or URL with the YouTrack Team.

YouTrack Log Files

1. Locate the logs directory.

ZIP installation: <YouTrack Server home directory>/logs.
Docker installation: log files are located in the mapped directory provided during the YouTrack installation: -v <path to logs directory>:/opt/youtrack/logs.

How to find the logs directory location via the YouTrack UI: go to Settings (Cog icon) → Server Settings → Global Settings → Server Configuration → View Server Metrics → Logs Location.

2. Archive the entire logs directory using any archiving tool of your choice.

3. Share the archive with the YouTrack Support Team. If the archive exceeds the ticket's file upload limit, you can upload it to https://uploads.youtrack.cloud (only the YouTrack Team can download the uploaded files) and share the upload ID.

YouTrack Database Files

1. Create a database backup via the YouTrack built-in tool. Go to Settings → Server Settings → Database Backup. This is the safest and recommended option for creating a YouTrack database backup.

2. If you don't have access to the YouTrack UI (e.g., due to a crash), you can find the database files directly on your disk. Create an archive of the data directory. Never modify the directory and its files manually.

ZIP installation:<YouTrack Server home directory>/data.
Docker installation: data files are located in the mapped directory provided during the YouTrack installation:-v <path to data directory>:/opt/youtrack/data.

3. Share the archive with the YouTrack Support Team. If the archive exceeds the ticket's file upload limit, you can upload it to https://uploads.youtrack.cloud (only the YouTrack Team can download the uploaded files) and share the upload ID.

YouTrack Conf Files

1. Locate the conf directory.

ZIP installation: <YouTrack Server home directory>/conf.
Docker installation: conf files are located in the mapped directory provided during the YouTrack installation:-v <path to conf directory>:/opt/youtrack/conf.

2. Archive the entire conf directory using any archiving tool of your choice.

3. Share the archive with the YouTrack Support Team. If the archive exceeds the ticket's file upload limit, you can upload it to https://uploads.youtrack.cloud (only the YouTrack Team can download the uploaded files) and share the upload ID.

HAR Files

Google Chrome:

  1. Open Chrome and access the Developer Tools via Menu () → More Tools → Developer Tools or by pressing F12 (Fn + F12 on MacOS) on your keyboard.

  2. Go to the Network tab.

  3. Ensure that recording is enabled by checking the round button at the top left. It should be red2024-07-10—red.png.

  4. Enable the Preserve log option to retain the network activity across different pages.

  5. Before reproducing the issue, click the clear button  to clear any existing data.

  6. Reproduce the issue you are experiencing.

  7. Right-click on the grid and select Save as HAR with Content to save the captured data.

Firefox:

  1. Open Firefox and access the Developer Tools via Menu () → More Tools → Developer Tools or by pressing F12 (Fn + F12 on MacOS) on your keyboard.

  2. Go to the Network tab.

  3. Ensure that recording is enabled by checking the pause icon at the top center 2024-07-10—pause.png.

  4. Enable the Preserve log option to retain the network activity across different pages.

  5. Before reproducing the issue, click the clear button  to clear any existing data.

  6. Reproduce the issue you are experiencing.

  7. Right-click on the grid and select Save All As HAR to save the captured data.

Microsoft Edge: 

  1. Open Microsoft Edge and access the Developer Tools via Menu (…) → More Tools → Developer Tools or by pressing F12 (Fn + F12 on MacOS) on your keyboard.

  2. Go to the Network tab.

  3. Ensure that recording is enabled by checking the round button at the top left. It should be red2024-07-10—red.png.

  4. Enable the Preserve log option to retain the network activity across different pages.

  5. Before reproducing the issue, click the clear button 2024-07-10—clear.png to clear any existing data.

  6. Reproduce the issue you are experiencing.

  7. Right-click on the grid and select Save all as HAR with Content to save the captured data.

Safari:

  1. Open Safari and check if you see Develop in the top bar menu. If so, proceed to step 3.

  2. Go to Safari → Settings → Advanced → Show features for web developers.
  3. From the Develop menu, select Show Web Inspector.
  4. Go to the Network tab.

  5. Enable the Preserve log option to retain the network activity across different pages under the filter options 2024-07-10—filters.png.

  6. Before reproducing the issue, click the clear button 2024-07-10—clear.png to clear any existing data.

  7. Reproduce the issue you are experiencing.

  8. Right-click on the grid and select Export HAR to save the captured data.

Other Browsers:

Chromium-based browsers (e.g., Vivaldi, Brave, etc.) should have instructions similar to those for Chrome. These instructions are not specific to YouTrack, so you can follow any other manuals for recording and capturing HAR in browsers. 

 

12 out of 21 found this helpful
4 comments

We're using the cloud service. There is no `Logs location` in the server settings. Would be useful to know where to find logs in a cloud instance.

0

Hello, for Cloud instances, logs are available only for the support team. To check them, we usually ask you to share your instance name. I've updated the article accordingly. 

Hope it helps. 

Edited by Anastasia Bartasheva
1

Thanks Anastasia

How/where would the support team request those logs? Could you add that in the article so that other cloud users don't have to read the comments to find out where and how to request their logs?

Thanks again

0

Usually, the support team checks the logs in scope of a submitted support ticket. You can submit a ticket here if you have a question or a problem. 

1

Please sign in to leave a comment.

Have more questions?

Submit a request