# Troubleshooting Known Issues
This page collects known problems that you might encounter when working with Teamscale along with their respective solutions.
- Teamscale Does Not Start: Web Interface Is Not Reachable
- Teamscale Does Not Start: Invalid maximum heap size: -Xmx4096m
- Teamscale Runs Into Memory-Related Problems
- Analysis is Slow
- Jira Does Not Render Teamscale Annotations Correctly
- Cross-Site Scripting (XSS) Errors
- Vsix-Installer Crashes When Manually Installing Teamscale's Visual Studio Extension
- TransportException: Object too large When Using Git Connector
- Some URLs Do Not Work When Running As Azure App Service
- Wrong Version of clang-tidy (or LLVM)
- SAP Connection Does Not Import New Code Anymore
- Test coverage is missing in Teamscale
- Troubleshooting the IntelliJ Integration for Teamscale
# Teamscale Does Not Start: Web Interface Is Not Reachable
You are trying to start Teamscale but the web interface (usually located at http://localhost:8080) is not reachable.
Check the log files: There are several locations where logs are written that may contain helpful information about why Teamscale is not starting:
- On Linux:
- On Windows if you installed Teamscale as a service:
If you are unsure which entries in the log file are related to the startup problem, you can rename the old logs, then restart Teamscale. It will automatically create new log files.
If you have recently updated Java, please ensure that
JAVA_HOME points to the right directory.
If you're running Teamscale as a service, please also check the relevant service configuration files under
If you have SSL enabled, please try commenting out all options starting with
config/teamscale.properties to temporarily disable SSL.
If this works, you now know that a faulty SSL configuration is causing the startup problems.
Access Teamscale via
While debugging startup problems, test Teamscale's availability by accessing it via
localhost on the machine where it is installed.
If this works but accessing it via the server/hostname does not, you now know that a network problem (firewall, missing connectivity) is causing Teamscale to not be available.
Run Teamscale manually:
If you are running Teamscale as a service, try running it via
If this works, you now know that there is a problem with your service setup (e.g. running as a different user with missing permissions or path misconfiguration).
# Teamscale Does Not Start:
Invalid maximum heap size: -Xmx4096m
When starting Teamscale fails with an error message like
Invalid maximum heap size: -Xmx4096m, this is most likely caused by using a 32-bit Java Virtual Machine (JVM).
Teamscale requires a 64-bit JVM.
# Teamscale Runs Into Memory-Related Problems
If you face a memory-related problem in Teamscale, this section may help you remedy the issue.
# Problem Description
Teamscale is running out of memory while fetching data or analyzing the code (often after a drastic slow-down due to the JVM trying to free memory) . A line similar to this one appears in the log files or the worker log:
java.io.IOException: java.lang.OutOfMemoryError: Java heap space
# Addressing the Memory Problems
# First: Exclude all Generated Code Requires Re-Analysis
The main source of problems when Teamscale runs out of memory is when the clone detection tries to find clones on large chunks of generated (often highly similar) code. Therefore, the first solution should be to exclude any generated code in the project you are analyzing. For that, you will need to edit the configuration of the affected project.
Using path patterns:
For example, to exclude all code that lives in the folder
gen-src, use the following exclude patterns on the Excluded File Names project setting:
The exclusion patterns are regular ant include patters
Using file content patterns:
If excluding code by using directory structures does not work, you can use the advanced field Content Exclude. Use this to exclude files by their content, using regular expressions. For example to exclude all files that contain the documentation string
generated by Visual Studio, add the pattern:
.*generated by Visual Studio.*
Please note that changes to these project options will require a re-analysis of the project.
# Second: Adjust Memory Settings Requires Restart
If you have excluded all your generated source code and Teamscale still runs out of memory, you can adjust the amount of memory used by Teamscale.
# Reserving Additional Memory
This can be done by editing
Adjust the value of the
JVM_MEMORY parameter, for example by reserving up to 16 gigabyes of RAM:
# Reducing the Number of Workers
If your Teamscale server does not have more memory that ought to be reserved, you can also adjust the number of workers that Teamscale should use.
This can be done in the
config folder) via the
Note that this will likely slow down the analysis, as Teamscale can parallelize less processes.
As a rule of thumb, we recommend to reserve 2 GB of memory for each Teamscale worker. However, due to varying analysis setups, this is only the lower bound to keep in mind.
# Still Experiencing Problems?
In case Teamscale's analysis is still affected by out-of-memory problems, please don't hesitate to contact our support.
# Analysis is Slow
Certain virus scanners are known to have a negative impact on the performance of Teamscale's analyses. It is hence advisable to place the following directories on your virus scanner's allow list, i.e., to exempt them from scanning:
- The Database Directory:
By default, this will be the
storagedirectory within your Teamscale installation. (This location can be overridden by setting the
database.directoryproperties in your
- Temporary-Files Directory:
By default, this will be the temporary-files directory used by your operating system (On Windows:
%USERPROFILE%\AppData\Local\Temp; on macOS/Linux:
/tmp). (This location can be overridden by adding a
-Djava.io.tmpdir=...argument to the
JVM_EXTRA_ARGSvariable in your
# Jira Does Not Render Teamscale Annotations Correctly
Teamscale can annotate Jira tickets with the finding/test-gap information aggregated over commits for that ticket. This can be enabled in the Jira connector in the project settings.
If it looks like in the following screenshot, Jira does not render the markdown content correctly:
This problem can be solved by configuring Jira to the wiki style renderer:
- Log in to JIRA as a JIRA administrator.
- Navigate to Administration > Issues > Field Configurations.
- Click on the Configure link for the field configuration used by the field to which Teamscale writes.
- Click on the Renders link for the field to change.
- Select the new renderer type from the Active Renderer drop-down list. Select the Wiki style renderer.
- Click on Update to apply the change.
Afterwards, Teamscale's annotations in Jira ticket should be rendered properly:
# Cross-Site Scripting (XSS) Errors
If access to a Teamscale instance is being managed by an external server such as NGINX (which is a recommended practice), it may be necessary to adapt the header settings to accommodate the cross site scripting and request forgery guarding mechanisms built into Teamscale.
Specifically, this is the case when an error message appears containing the text
X-Requested-By header is missing.
To fix this, insert the following line in your NGINX configuration file at the appropriate place (e.g., the server you want to configure):
add_header 'Access-Control-Allow-Headers' 'X-Requested-By';
# Vsix-Installer Crashes When Manually Installing Teamscale's Visual Studio Extension
When installing the Teamscale Visual Studio Extension in Visual Studio 2015 on Windows 10, a
XamlParseException similar to following error may occur:
System.Windows.Markup.XamlParseException was unhandled Message: An unhandled exception of type 'System.Windows.Markup.XamlParseException' occurred in PresentationFramework.dll
As a workaround, the extension can be installed manually via the command line as follows:
\path\to\visualstudio\Common7\IDE\VSIXInstaller.exe /q <YOUR-TEAMSCALE_EXTENSION.vsix>
TransportException: Object too large When Using Git Connector
The Git connector reports this error when a Git repository that contains a file larger than 2 GB is connected to Teamscale. This is due to internal limitations of the Java Git implementation, which unfortunately cannot be circumvented.
A possible workaround is to clone the repository with a native Git client, which doesn't have this limitation, and then exclude the problematic file from Teamscale analysis:
- In the workspace directory, execute
git clone --bare $REPO_URL.
- Add the Git connector to the Teamscale project in question.
- When configuring the Git connector, use the Excluded file names option to exclude the respective file from analysis.
Another option is to remove the offending file from the history of the Git repository entirely, e.g., if it was added by accident. This StackOverflow question has some pointers on how to perform such an operation.
# Some URLs Do Not Work When Running As Azure App Service
Azure App Service runs your application behind a proxy server.
By default, this proxy will filter certain URLs, which can lead to pages not loading correctly in Teamscale.
For example, all URLs ending in
.cs are blocked by default.
To resolve this, you need to adjust the
web.config file in the root of your App Service similar to the following example:
<?xml version="1.0" encoding="UTF-8"?> <configuration> <system.webServer> <handlers> <add name="httpplatformhandler" path="*" verb="*" modules="httpPlatformHandler" resourceType="Unspecified" requireAccess="Script" /> </handlers> <httpPlatform stdoutLogEnabled="true" startupTimeLimit="300" startupRetryCount="0" processPath="%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" arguments="%home%\site\wwwroot\HttpPlatformHandlerStartup.ps1"> </httpPlatform> <security> <requestFiltering> <hiddenSegments> <clear /> </hiddenSegments> <fileExtensions> <clear /> </fileExtensions> </requestFiltering> </security> </system.webServer> </configuration>
# Wrong Version of
clang-tidy (or LLVM)
Teamscale can execute clang-tidy on your C/C++/Objective-C source code and manage the reported findings. This feature requires that clang-tidy 10.0.0 is installed on the server. We require this exact version since the checks and check descriptions supported by clang-tidy are stored in Teamscale (the clang-tidy binary has no option to print all descriptions). Our docker images already come with a clang-tidy binary. With all other distributions, you need to install clang-tidy 10.0.0 on the Teamscale server.
Automatically Check the Clang Tidy Setup
Teamscale offers a REST service to verify whether clang-tidy is correctly installed:
# SAP Connection Does Not Import New Code Anymore
If one of your Teamscale projects does not show current ABAP code changes from your SAP system anymore, this section may help you remedy the issue. As a general recommendation, please make sure you are running the latest versions of both Teamscale and the Teamscale Connector for SAP NetWeaver® AS ABAP®.
# Problem Description
Teamscale does not show recent ABAP code changes for one of the SAP systems connected via the Teamscale Connector for SAP NetWeaver® AS ABAP®. The most recent commit shown in the Activity perspective does not reflect current changes in the system.
# Inspecting the Worker Log
The first thing to inspect is the worker log. In the System perspective, select the Worker Log entries for Maintenance Jobs and enter
abapsystem into the Regex field:
Then click on the most recent error entry, and inspect the detailed log message.
# Error: Export Configuration Locked
The worker log entry contains a message like
Error occurred during ABAP export in SAP system Unable to lock export for configuration id CQI_MUYWGCIN. An other export for this configuration may be running. Or an earlier export could not finish properly. Export aborted.
Check Shadow Mode Settings
Make sure you have only one Teamscale instance running in non-shadow mode and accessing the same Teamscale working directory.
# Solution (Teamscale Administrators)
- Log into Teamscale as an administrator
- Enter the following into your browser:
- Find the entry for SAP/clearHistoryIdLock
- Click Try it out, enter the SAP Configuration ID, and click Execute.
- If the service responds with a return code of 204, the export configuration has been successfully unlocked.
# Solution (SAP System Administrators)
- Log on to the SAP system using SAPGui.
- Locate the database table /CQSE/ABAPEXP (e.g. in SE11)
- In the entry with the EXPORT_CONFIG_ID from the error message, change LOCKED from
# Error: Crash in the SAP system
Under certain conditions, the export in the SAP system can fail.
The worker log entry contains a line like
RfcException raised by system [CQR|abap-rel|00]:
This means that an error occurred in the SAP system. In this case, we need more information from the SAP system.
# Gathering Further Information
- Note the time the error was logged in the worker log.
- Log on to the SAP system using SAPGui.
- Open transaction ST22 and search for short dumps caused by the Teamscale user at the time noted in step 1.
- Export the short dump into a text file
- Send the file to firstname.lastname@example.org or request a link to perform an HTTPS-secured upload
- Our experts will investigate the reason for the crash and provide you with mitigation instructions
# Possible Reasons
There are a number of different things that can cause a code export to crash.
Of course, our SAP connector heavily relies on SAP standard functionality.
Sometimes these standard routines do not handle edge cases very well, which might lead to crashes.
Our exporter does have extensive error handling functionality, but some conditions cannot be handled programmatically, but immediately lead to a dump, e.g. violation of
ASSERT conditions, or unbound field symbols, to name just two.
These conditions can occur e.g. when Code Inspector is executed for an object with rarely used syntax, when DDIC information or function groups have become inconsistent because of some previous error condition unrelated to Teamscale.
Depending on the cause for the crash, there are different mitigation strategies to disable certain functionalities of the SAP Connector, so that the condition causing the crash does not occur anymore. You may search the call stack for the last code block belonging to the /CQSE/ namespace in order to locate the export step the error is related to, e.g. Code Inspector checks or DDIC export.
# Code Inspector
In case of Code Inspector crashes, you may search the short dump for the value of the variable
OBJECT_NAME to identify which object Code Inspector was checking when it crashed.
Then, have a look at the ABAP code in your favorite ABAP editor, and try to check it manually using Code Inspector.
If the check fails, you have the following options:
- Adjust your ABAP code so that Code Inspector can successfully run the check
- Search the SAP Support Portal for a note fixing the check (e.g. Note 2215785)
- In the SAP system, disable the particular check in the check variant that is used by Teamscale
- Add the particular object to the Code Inspector exclude specification in Teamscale's SAP connection settings for the respective system to exclude it from Code Inspector checks. Be sure to use the object name as shown in Teamscale:
# DDIC Export
In case the crash is related to the DDIC export, you may search the short dump for strings such as
PROGRAM_NAME to determine which DDIC object caused the crash.
Then, open the respective DDIC object with SAPGui and run consistency checks (e.g. to identify broken foreign-key relationships in database tables).
- Fix the inconsistencies in the respective DDIC object
- Disable the option Include objects in ABAP Dictionary (DDIC) in Teamscale's SAP connection settings for the respective system
# Error: Timeout
Similar to crashes related to programming errors or data inconsistency, in some cases the RFC connection to the SAP system may be terminated due to a timeout in the SAP system.
The worker log entry contains a line like
RfcException raised by system [CQR|abap-rel|00]: message: Zeitlimit überschritten
Please make sure that
- The SAP user configured in Teamscale is not a dialog user (see RFC User for Teamscale)
- You use asynchronous communication if Code Inspector is enabled (see Asynchronous Full Export)
If the problem persists, please:
- Perform an ABAP trace and/or an SQL trace on your system during export
- Send the results to email@example.com or request a link to perform an HTTPS-secured upload
- Our experts will investigate the reason for the crash and provide you with further instructions
# Test coverage is missing in Teamscale
To narrow down the problem please check the following:
Check the status information of the upload
Navigate to the Project Configuration perspective.
Select the Projects view and click on the icon for the project that is missing coverage.
Now in the External Uploads View, expand the partition of the upload and search for the commit.
Be aware that the date and time refers to the code commit for which the coverage has been uploaded, as opposed to the time at which the upload happened.
If you can't find the commit, something must have gone wrong during the actual upload.
In this case, please have a look at the Service Log in the System perspective and check our upload script output or tooling logs, depending on how the upload is executed.
Otherwise, click on the commit to see all the details for the upload.
It lists all the state transitions of the upload and provides hints when something went wrong.
The last state should be
Check the worker logs for related warnings and errors
Next you might want to check the Worker Log in the System perspective. Open the worker log for your project. Select Errors and warnings and search for entries related to the upload commit e.g., by searching for the timestamp with the Filter option. Click on the entry to see all the log messages.
Check whether the coverage report actually contains coverage information
Make sure that there are parts in the report that actually contain covered lines or instructions. This of course depends on the concrete report format.
# Teamscale JaCoCo Agent
You have attached the Teamscale JaCoCo Agent to your application according to the documentation but you are not seeing the coverage you expected or maybe even no coverage at all.
Always Check the Logs
The first step in troubleshooting such problems is always to look at the log file the agent writes at
If it contains any errors, please resolve these first.
Examples are network connectivity issues or incorrectly configured command line arguments.
It also tells you whether the agent was started at all since the agent will always log at least an
INFO entry at startup.
First, we'll verify the most basic setup: The agent must at least start and write coverage files to disk.
Please remove all options starting with
teamscale- and the
This allows you to inspect the coverage reports.
Coverage is written to
Please ensure that the agent can create files inside this directory.
Please disable all other
-agentlib arguments to your JVM to avoid interference of other agents with the Teamscale JaCoCo agent.
Re-run your application and then shut it down. Coverage files are always written on shut down of the application.
- A coverage file must be created in
- If not, please check the agent's logs in
- If no logs were created, then the agent was not started. Please re-check your configuration and the logs of your own application.
# No Coverage Data is Generated at All
Problem: Your Application Is Not Shut Down Gracefully
If no coverage file was created or the coverage file is truncated (i.e. does not end with
</report>), then it may be that your JVM did not shut down gracefully.
Please ensure that no other process is forcefully killing your JVM, e.g. a service running, Docker, an application server etc.
# Coverage Files Can Be Generated But Upload to Teamscale Fails
If a coverage file was written but upload to Teamscale fails when configuring the
teamscale- options, please verify that the server where the agent is installed can reach the Teamscale server.
Problem: Your Servers Cannot Reach Each Other
On the agent's server:
- Run a
pingof the IP address of the Teamscale server.
curl -v TEAMSCALE_URL/login.htmland check for connection problems. Teamscale must respond with the login page's HTML, HTTP status 200.
- Ensure that no firewalls or reverse proxies are causing issues.
- If a proxy is required, please configure the proxy for your JVM so the agent can use it.
Problem: You Provided the Wrong Authentication Information
If a network connection is possible, common mistakes that prevent an upload to Teamscale are:
teamscale-useryou provided does not have the Perform External Uploads permission in Teamscale.
- You provided the
teamscale-user's password instead of their access token in the
# Coverage Uploads Are Shown In Teamscale But Coverage Is Missing
You can see the coverage uploads as
Processed in Teamscale under Project Configuration > .
You can also see the upload under Activity.
However, when you click on that upload in Activity, either all or some coverage is missing when you check the list of covered files.
Problem: Your Include/Exclude Patterns Are Misconfigured
Please run the agent with patterns that include all code:
Run your application and upload coverage to Teamscale again If you now see the missing coverage, then your previous include/exclude patterns were not configured correctly and were excluding the code you wanted to profile.
Problem: You Are Profiling the Wrong Process
The profiler will only profile the code running within the JVM which receives the
I.e. if your main Java process spawns another, it must pass on the
-javaagent argument to the child process or the code running in the child will not be profiled.
Please ensure that the JVM that is running the code you wish to profile actually receives the
-javaagent argument, e.g. with a process explorer tool that can show the command line of a process.
Problem: Interference by Another Java Agent
Other Java Agents can disrupt the JaCoCo agent in a way that prevents it from instrumenting your classes.
Please disable all other
-agentlib arguments to your JVM.
If this resolves your issue, you have two options:
- either leave the other agent disabled while you collect coverage
- or try to reorder the agents so the Teamscale JaCoCo agent's
-javaagentargument is the first such argument on the JVM's command line. In many cases, this will also resolve the conflict.
# Troubleshooting the IntelliJ Integration for Teamscale
In order to determine the root cause of the problem, we need debug logs from your IntelliJ installation. To enable debug logging (available since Teamscale 5.3.0), go to either Help > Debug Log Settings… or Help > Diagnostic Tools > Debug Log Settings…, depending on your IntelliJ version. Then, enter the following log categories, one per line:
Save your changes and close the dialog. Then, please reproduce the problem in the open IDE window. Afterwards, you can access the log files under Help > Show Log in Files and send them to CQSE support for analysis.