Server Profiling

General Info

Plugin Description

Allows to take CPU and memory profiling snapshots of the TeamCity server right from the web UI.

Download

Last build on public TeamCity server.

TeamCity Versions Compatibility

Plugin is compatible with TeamCity 2017.x and newer versions.

Installation

• download serverProfile.zip file and Install it (TeamCity plugin installation instructions)
• copy files from the bin/<your platfom> directory to the <TeamCity Data Directory>/lib directory. Here <your platfom> is the name of your platform, like win32 for Windows XP, win-amd64 for Windows XP x64 Edition, etc.

• change TEAMCITY_SERVER_OPTS environment variable by adding -agentpath JVM argument: 

  -agentpath:<path to TeamCity data directory>/lib/<YourKit agent dll or so>=disableall,sessionname=TeamCity,dir=<path to TeamCity logs directory>/snapshots

  For example, assuming that TeamCity is installed on Windows under C:\TeamCity and TeamCity data directory is set to C:\ProgramData\JetBrains\TeamCity (note the usage of back slashes):

  set TEAMCITY_SERVER_OPTS=-agentpath:C:/ProgramData/JetBrains/TeamCity/lib/yjpagent.dll=disableall,sessionname=TeamCity,dir=C:/TeamCity/logs/snapshots

  For Linux if data directory is set to /data/teamcity_server/datadir and installation directory is /opt/teamcity:

  export TEAMCITY_SERVER_OPTS=-agentpath:/data/teamcity_server/datadir/lib/libyjpagent.so=disableall,sessionname=TeamCity,dir=/opt/teamcity/logs/snapshots

• Restart TeamCity server and check that server profiling plugin is loaded on Administration | Plugins List page.

Usage

To start the profiling navigate to the Administration | Diagnostics | Server Profiling page.

• On capturing the snapshot, the path to the saved snapshot is displayed. The profiling activity is logged into the server's console.
• Send the profiling results to the TeamCity Developers with a description of the problem.

CPU Profiling

• Click "Start" to start profiling
• Perform the action to reproduce the CPU load
• Click "Capture" to capture profiling snapshot, or "Cancel" to cancel profiling.

Memory Profiling

• When you believe that the memory consumption by the TeamCity server process is high, click "Capture" to capture the snapshot.
  Please note the this operation blocks server until the snapshot is fully captured. The UI for all the server users will not be refreshed until the snapshot is taken.

Development links

Sources
Builds at JetBrains public TeamCity instance.

History