If you experience problems running TeamCity and believe they are related to the software, please contact us with a detailed description of the issue.
To fix a problem, we may need a wide range of information about your system as well as various logs. The section below explains how to collect such information for different issues.
In this section:
Following these guidelines will ensure timely response and effective issue resolution. Check Feedback for appropriate ways to contact us.
|
If TeamCity is running slower than you would expect, please use the notes below to locate the slow process and send us all the relevant details if the process is a TeamCity one.
If you experience a slow TeamCity web UI response, checking for changes process, server-side sources checkout, long cleanup times or other slow server activity, your target should be the machine where the TeamCity server is installed.
If the issue is related only to a single build, you will need to investigate the TeamCity agent machine which is running the build and also the server.
Investigate the system resources (CPU, memory, IO) load. If there is a high load, determine the process causing it. If it is not a TeamCity-related process, that might need addressing outside of the TeamCity scope. Also check for generic slow-down reasons like anti-virus software, maintenance times, etc.
If it is the TeamCity server that is loading the CPU/IO or there is no substantial CPU/IO load and everything runs just fine except for TeamCity, then this is to be investigated further.
Check if you have any Conflicting Software like anti-virus running on the machine and disable/uninstall it.
Check that the database used by TeamCity and the file storage of the TeamCity Data Directory do not have performance issues.
If you have a substantial TeamCity installation, check your memory settings as the first step.
During the slow operation, take several thread dumps of the slow process (see below for thread dump taking approaches) with 5-10 seconds interval. If the slowness continues, take several more thread dumps (e.g. 3-5 within several minutes) and then repeat after some time (e.g. 10 minutes) while the process is still being slow.
Then send us a detailed description of the issue accompanied with the thread dumps and full server (or agent) logs covering the issue. Unless it is undesirable for some reason, the preferred way is to file an issue into our issue tracker and let us know via support email. Please include all the relevant details of investigation, including the CPU/IO load information, what specifically is slow and what is not, note affected URLs, visible effects, etc.
For large amounts of data, use our file upload service to share the archives with us.
When an operation on the server is slow, take a set of the server thread dumps (10+) spread over the time of the slowness. TeamCity automatically saves thread dumps on super slow operations, so there might already be some saved in logs/threadDumps-<date>
directories.
It is recommended to send us an archive of the entire content of server's <TeamCity Home
>/logs/threadDumps-<date>
directories for all the recent dates.
It is recommended that you take a thread dump of the TeamCity server from the Web UI if the hanging is local and you can still open the TeamCity Administration pages: go to the Administration | Server Administration | Diagnostics page and click the Save Thread Dump button to save a dump under the <TeamCity Home>/logs/threadDumps-<date>
directory (where you can later download the files from "Server Logs").
If the server is fully started but the web UI is not responsive, try the direct URL using the actual URL of your TeamCity server.
If the UI is not accessible (or the server is not yet fully started), you can take a server thread dump manually using the approaches described below.
You can also adjust the teamcity.diagnostics.requestTime.threshold.ms=30000
internal property to change the timeout after which a thread dump is automatically created in the threadDumps-<date>
directory under TeamCity logs whenever there is a user-originated web request taking longer than timeout.
If you experience degraded server performance and the TeamCity server process is producing a large CPU load, take a CPU profiling snapshot and send it to us accompanied with the detailed description of what you were doing and what your system setup is.
You can take CPU profiling and memory snapshots by installing the server profiling plugin and following the instructions on the plugin page.
Here are some hints to get the best results from CPU profiling:
It is recommended that you take an agent thread dump from the Web UI: go to the Agent page, Agent Summary tab, and use the Dump threads on agent action.
If the UI is not accessible, you can take the dump thread manually using the approaches described below. Note that the TeamCity agent consists of two java
processes: the launcher and agent itself. The agent is triggered by the launcher. You will usually be interested in the agent (nested) process and not the launcher one.
These can help if you are unable to take a thread dump from the TeamCity web UI.
To take a thread dump:
You have several options:
<TeamCity server home>\bin\teamcity-server.bat run"
command.Another approach is to figure out the process id of the TeamCity server process (it's the top-most "java" proces with "org.apache.catalina.startup.Bootstrap start" at the end og the command line and use of of the following approaches:
jstack <pid_of_java_process>
in the bin directory of the Java installation used to by the process (the Java home can be looked up in the process command line. If the installation does not have jstack utility, you might need to get the java version via java -version command, download full JDK of the same version and use "jstack" utility form there). You might also need to supply "-F" flag to the command.use TeamCity-bundled agent thread dump tool (can be found in the agent's plugins). Run the command:
<TeamCity agent>\plugins\stacktracesPlugin\bin\x86\JetBrains.TeamCity.Injector.exe <pid_of_java_process> |
Note that if the hanging process is run as a service, the thread dumping tool must be run from a console with elevated permissions (using Run as Administrator). If the service is run under System account, you might also need to launch the thread dumping tools via "PsExec.exe -s <path to the tool>\<tool> <options>". When the service is run under a regular user, wrapping the tool invocation in PsExec.exe -u <user> -p <password> <path to the tool>\<tool> <options>
might also help.
If neither of these work for the server running as a service, try running the server from console and not as a service. This way the first (Ctrl+Break) option can be used.
jstack <pid_of_java_process>
(using jstack from the Java installation as used by the process) or kill -3 <pid_of_java_process>
. In the latter case output will appear in <TeamCity Home>/logs/catalina.out
or <TeamCity agent home>/logs/error.log
.See also Server Performance section above.
When the server is slow, check if the problem is caused by database operations.
It is recommended to use database-specific tools.
You can also use the debug-sql
server logging preset. Upon enabling, all the queries which take longer 1 second will be logged into the teamcity-sql.log file. The time can be changed by setting the teamcity.sqlLog.slowQuery.threshold
internal property. The value should be set in milliseconds and is 1000 by default.
Along with the server thread dump, please attach the output of the "show processlist;" SQL command executed in MySQL console. Like with thread dumps, it makes sense to execute the command several times if slowness occurred and send us the output.
Also, MySQL can be set up to keep a log of long queries executed with the changes in my.ini
:
[mysqld] ... log-slow-queries long_query_time=15 |
The log can also be sent to us for analysis.
If you experience problems with TeamCity "eating" too much memory or OutOfMemoryError/"Java heap space" errors in the log, please do the following:
'-Xmx'
JVM option, like -Xmx1200m, e.g. Java Inspections builds may specifically need to increase -Xmx
value.java_xxx.hprof
file is be created in the process startup directory (<TeamCity Home>/bin
or <TeamCity Agent home>/bin
);jmap
standard JVM command line utility of the full JVM installation of the same version as the Java used by the process. Example command line is:jmap -dump:file=<file_on_disk_to_save_dump_into>.hprof <pid_of_the_process>
See how to change JVM options for the server and for agents.
lsof
, on Windows you can use handle or TCPView for listing sockets)ulimit -n
) and increase them if necessary. Please note that default Linux 1024 handles per process is way too small for a server application like TeamCity. Please increase the number to at least 16000. Please check the actual process limits after the change as there are different settings in the OS for settings global and per-session limits (e.g. see the post)If the number of files is large and looks suspicious and the locking process is a TeamCity one (the TeamCity agent or server with no other web applications running), then, while the issue is still occurring, grab the list of open handles several times with several minutes interval and send the result to us for investigation together with the relevant details.
Please note that you will most probably need to reboot the machine with the error after the investigation to restore normal functioning of the applications.
Please refer to Common Problems
The TeamCity server and agent create logs that can be used to investigate issues.
Before reproducing the problem it makes sense to enable 'DEBUG' log level for TeamCity classes. After that, DEBUG messages will go to |
For detailed information, please refer to the corresponding sections:
TeamCity Server Logs
Viewing Build Agent Logs
To enable VCS logging on the server side, switch logging preset to "debug-vcs" in administration web UI and then retrieve |
Most VCS operations occur on the TeamCity server, but if you're using the agent-side checkout, VCS checkout occurs on the build agents.
For the agent and the server, you can change the Log4j configuration manually in <TeamCity Home>/conf/teamcity-server-log4j.xml or <BuildAgent home>/conf/teamcity-agent-log4j.xml files to include the following fragment:
<category name="jetbrains.buildServer.VCS" additivity="false"> <appender-ref ref="ROLL.VCS"/> <appender-ref ref="CONSOLE-ERROR"/> <priority value="DEBUG"/> </category> <category name="jetbrains.buildServer.buildTriggers.vcs" additivity="false"> <appender-ref ref="ROLL.VCS"/> <appender-ref ref="CONSOLE-ERROR"/> <priority value="DEBUG"/> </category> |
Please also update the <appender name="ROLL.VCS"
node to increase the number of the files to store:
<param name="maxBackupIndex" value="30"/> |
If there are separate logging options for specific version controls, they are described below.
To enable SVN logging on the server side, switch the logging preset to "debug-SVN" in the administration web UI and then retrieve the |
An alternative manual approach is also necessary for agent-side logging.
First, please enable the generic VCS debug logging, as described above.
Uncomment the SVN-related parts (the SVN.LOG
appender and javasvn.output
category) of the Log4j configuration file on the server and on the agent (if the agent-side checkout is used). The log will be saved to the logs/teamcity-svn.log
file. Generic VCS log should be also taken from logs/teamcity-vcs.log
Uncomment the Clearcase-related lines in the <TeamCity Home>/conf/teamcity-server-log4j.xml
file.
The log will be saved to logs/teamcity-clearcase.log
directory.
In case the server-side checkout is used, the "patch" that is passed from the server to the agent can be retrieved by:
system.agent.save.patch=true
to the build configuration.the build log and the agent log will contain the line "Patch is saved to file ${file.name}"
Get the file and supply it with the problem description.
To investigate process launch issues for .Net-related runners, enable debugging as described below. The detailed information will then be printed into the build log. It is recommended not to have the debug logging for a long time and revert the settings after investigation.
Add the teamcity.agent.dotnet.debug=true
configuration parameter in the build configuration or on the agent and run the build.
|
The changes that are sent from the IDE to the server on a remote run can be retrieved from the server .BuildServer/system/changes
directory. Locate the <change_number>.changes
file that corresponds to your change (you can pick the latest number available or deduce the URL of the change from the web UI).
The file contains the patch in the binary form. Please send it with the problem description.
To enable debug logging for the IntelliJ Platform-based IDE plugin, include the following fragment into the Log4j configuration of the <IDE home>/bin/log.xml
file:
<appender name="TC-FILE" class="org.apache.log4j.RollingFileAppender"> <param name="MaxFileSize" value="10Mb"/> <param name="MaxBackupIndex" value="10"/> <param name="file" value="$LOG_DIR$/idea-teamcity.log"/> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d [%7r] %6p - %30.30c - %m \n"/> </layout> </appender> <appender name="TC-XMLRPC-FILE" class="org.apache.log4j.RollingFileAppender"> <param name="MaxFileSize" value="10Mb"/> <param name="MaxBackupIndex" value="10"/> <param name="file" value="$LOG_DIR$/idea-teamcity-xmlrpc.log"/> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d [%7r] %6p - %30.30c - %m \n"/> </layout> </appender> <category name="jetbrains.buildServer.XMLRPC" additivity="false"> <priority value="DEBUG"/> <appender-ref ref="TC-XMLRPC-FILE"/> </category> <category name="jetbrains.buildServer" additivity="false"> <priority value="DEBUG"/> <appender-ref ref="TC-FILE"/> </category> |
After changing this file, restart the IDE. The TeamCity plugin debug logs are saved into idea-teamcity*
files and will appear in the logs directory of the IDE settings ([<IDE settings/data directory>/system/log
directory.
(Applicable to IntelliJ IDEA and Eclipse)
Add the following JVM option before starting IDE:
-Dteamcity.activation.debug=true
the logging related to the open in IDE functionality will appear in the IDE console.
First of all, check that your VCS settings in IDEA correspond to the VCS settings in TeamCity.
If they do not, change them and it should fix the problem.
Secondly, check that the build configurations you expect to be suitable with your IDEA project has either server-side VCS checkout mode or agent-side checkout and NOT manual VCS checkout mode (it is not possible to apply a personal patch for a build with the manual checkout mode because TeamCity must apply that patch after the VCS checkout is done, but it does not know or manage the time when it is performed).
If the settings are the same and you do not use the manual checkout mode but the problem is there, do the following:
To enable tracing for the plugin, run Eclipse IDE with the -debug
<filename>
command line parameter. The <filename>
portion of the argument should be a properties file containing key-value pairs. The name of each property corresponds to the plugin module and the value is either 'true
' (to enable debug) or 'false'
. Here is an example of enabling most common tracing options:
jetbrains.teamcity.core/debug = true jetbrains.teamcity.core/debug/communications = false jetbrains.teamcity.core/debug/ui = true jetbrains.teamcity.core/debug/vcs = true jetbrains.teamcity.core/debug/vcs/detail = true jetbrains.teamcity.core/debug/parser = true jetbrains.teamcity.core/debug/platform = true jetbrains.teamcity.core/debug/teamcity = true jetbrains.teamcity.core/perfomance/vcs = true jetbrains.teamcity.core/perfomance/teamcity = true |
Read more about Eclipse Debug mode Gathering Information About Your Plug-in and built-in Eclipse help.
To capture logs from the TeamCity Visual Studio Addin:
1. Locate the Visual Studio installation directory (in the example below c:\Program Files (x86)\Microsoft Visual Studio\2017
\Common7\IDE
)
2. Run Microsoft Visual Studio executable (INSTALLATION_DIRECTORY\Common7\IDE\devenv.exe
) from the command line with the ReSharper-related command line arguments:
For TeamCity VS Add-in as a part of ReSharper Ultimate use /ReSharper.LogFile <PATH_TO_FILE>
and /ReSharper.LogLevel <Normal|Verbose|Trace>
switches
c:\Program Files (x86)\Microsoft Visual Studio\2017\Common7\IDE>devenv.exe /ReSharper.LogFile C:\Users\jetbrains\Desktop\vs.log /ReSharper.LogLevel Verbose |
/TeamCity.LogFile <PATH_TO_FILE>
and /TeamCity.LogLevel <Normal|Verbose|Trace>
switchesTo troubleshoot common Visual Studio, run Microsoft Visual Studio executable (INSTALLATION_DIRECTORY\Common7\IDE\devenv.exe
) with the /Log
command Line switch and send us resulting log file.
To collect additional logs generated by JetBrains dotCover, add the teamcity.agent.dotCover.log
configuration parameter to the build configuration with a path to an empty directory on the agent.
All dotCover log files will be placed there and TeamCity will publish zipped logs as hidden build artifact .teamcity/.NETCoverage/dotCoverLogs.zip
.
{hidden-data}from http://youtrack.jetbrains.com/issue/TW-17058#comment=27-240592{hidden-data} |
On a rare occasion of the TeamCity server or agent process terminating unexpectedly with no apparent reason, it can happen that this is caused by a Java runtime crash.
If this happens, the JVM regularly creates a file named hs_err_pid*.log
in the working directory of the process. The working directory is usually <TeamCity server or agent home>/bin
Under WIndows when running as a service it can be other like C:\Windows\SysWOW64
. You can also search the disk for the recent files with "hs_err_pid" in the name.
See also related the Fatal Error Log section in the document.
Please send this file to us for investigation and consider updating the JVM for the server (or for agents) to the latest version available.
If you get the "There is insufficient memory for the Java Runtime Environment to continue. Native memory allocation (malloc) failed to allocate ..." message with the crash or in the crash report file, make sure to switch to 64 bits JVM or reduce -Xmx setting not to increase 1024m, see details in the memory configuration section.
While investigating issues related to a build log, we might need the raw binary build log as stored by TeamCity.
It can be downloaded via the Web UI from the Build Log build's tab: select "Verbose" log detail and use the "raw messages file" link at the top-right.
The inspections result from a TeamCity build may not match inspections from a local run in IntelliJ IDEA.
To help us investigate issues with inspections, do the following:
system.teamcity.dont.delete.temp.result.dir=true"
to the configuration parameters"%system.teamcity.build.tempDir%/inspection*result/** => inspections-reports-data-%build.number%.zip"
rule to Artifact paths"%system.teamcity.build.tempDir%/idea-logs/** => inspections-reports-idea-logs-%build.number%.zip"
rule to Artifact paths"-Didea.log.path=%system.teamcity.build.tempDir%/idea-logs/"
to the runner's 'JVM command line parameters' field.'inspections-reports-*.zip'
files.
Files under 10 MB in size can be attached right into the tracker issue (if you do not want the attachments to be publicly accessible, limit the attachment visibility to "teamcity-developers" user group only).
You can also send small files (up to 2 MB) via email: teamcity-support@jetbrains.com or via online form (up to 20 MB). Please do not forget to mention your TeamCity version and environment and archive the files before attaching.
FTP
If the file is over 10 MB, you can upload the archived files to ftp://ftp.intellij.net/.uploads and let us know the exact file name. If you receive the permission denied error on an upload attempt, please rename the file. It's OK that you do not see the file listing on the FTP.
The FTP accepts standard anonymous credentials: username: "anonymous", password: "<your e-mail>".
In addition to usual, unencrypted connections, TLS ones are also supported.
In case of access issues, time-out errors, etc. please try using passive FTP mode.
{hidden-data} curl -v -u anonymous:xxx ftp://ftp.intellij.net/.uploads/ -T "companyName_date_archive.zip" {hidden-data} |
HTTP
You can upload a file via https://uploads.services.jetbrains.com/ form and let us know the exact file name.
If you cannot upload a large file in one go, try splitting the file into parts and upload them separately.