Missing Applications

After onboarding, you might not see your application appear in the Applications grid. There are a few reasons why this could happen.

The server and application are displayed incorrectly

  • Reason: The server on which the application is running doesn't have Contrast installed.

Check out standard or file a ticket with the diagnostic log output file to see what's happening. If your server isn't appearing in the Contrast interface, learn more from the Installation Issues page.

  • Reason: The application is running at the root context and has no <display-name> in web.xml.

Contrast needs a name to uniquely identify an application; if an application runs at the root, it requires a <display-name> to provide this unique name. You can use the contrast.rootapp system property to specify the name of an application running at the root if you can't add a <display-name>.

  • Reason: The application, or an application with the same name and context path, was archived.

The server appears in the Contrast interface, but the application doesn't

  • Reason: The application hasn't been used yet.

Contrast won't recognize your application until you use it. Visit the application after you successfully start up your server with Contrast. Once it's accessed, Contrast spends a few seconds analyzing it - even big applications should take less than a minute. You may notice a pause when you first access your application as this analysis is taking place.

  • Reason: The application is running on an unsupported container.

Contrast is officially supported on the following containers:

  • Tomcat 5, 6, 7, 8
  • Jetty 6, 7, 8, 9
  • JBoss 5.1, 6.1, 7, 7.1
  • GlassFish 3
  • WebSphere 6.0, 7.0, 8.5
  • WebLogic 9, 10g, 11c, 12c
  • IIS 6+

MySQL Logging

Log Database Queries with Embedded MySQL

Enterprise-on-Premises (EOP) customers can use the embedded MySQL instance packaged with Contrast or integrate Contrast with a distributed MySQL instance. For customers leveraging the embedded MySQL instance, Contrast provides a configurable property file in $CONTRAST_HOME/data/conf/mysql.properties. This file is very similar to the my.cnf file that is leveraged natively within MySQL.

Sample Properties File

Two logging flags are available: general logging and slow query logging.

General logging is used to log every statement executed by MySQL. Customers who use this option should be very careful, as this log can grow to many 100s of gigabytes of storage over a very short window of time. Contrast recommends that you use general logging only for debugging purposes and that you disable it at all other times.

Slow query logging is used to evaluate queries that take a particularly long period of time. MySQL monitors the SQL and measures the time it takes to execute. When enabled, this log grows from many megabytes to gigabytes depending on whether a system is very slow. Contrast recommends that you keep this option enabled, but that you pay close attention to the size of the log file over time.

An example from the mysql.properties file created with Contrast as part of an embedded installation/upgrade:

# The destination for general query log and slow query log output
log_output=FILE
log_queries_not_using_indexes=ON
general_log=OFF
general_log_file=${Contrast.Data.Log}/mysql.log

# Log errors and startup messages to this file
log_error=${Contrast.Data.Log}/mysql_error.log

# Whether the slow query log is enabled. "Slow" is determined by the value of the long_query_time variable
slow_query_log=OFF
#The name of the slow query log file
slow_query_log_file=${Contrast.Data.Log}/mysql-slow.log

Upgrade Agents

Enterprise-on-Premise (EOP) administrators can download a new agent from the Contrast Hub Site and copy the individual agent artifact(s) to a directory on the Contrast application. In the event an issue happens after copying files during configuration, review the contrast.log located under $CONTRAST_HOME/logs for more information about what's causing an issue within the Contrast application. A few troubleshooting techniques are outlined in the following sections.

Permissions Issue on the Agent

If this issue occurs, make sure to verify that the user who owns the $CONTRAST_HOME directories and files happens to be the same owner of the agent files placed in the respective directories. Try to avoid copying files as the ROOT user or another named user. Make sure the ownership (contrast-service) and permissions (755) match other files and directories under $CONTRAST_HOME.

File Placed in the Wrong Directory

It may seem obvious to place the NodeJS agent in the Node directory and the same for other agents, but you should always double-check that the files are in the right directory. If the wrong files are placed in a particular directory, the server shouldn't have an issue. However, you won't be able to download the updated agent until the file is moved to the appropriate directory.

Size of Download Doesn't Match

Occasionally, downloads can become corrupt when transferring via download over HTTP/HTTPS as well as copying files from one machine to the next. If this happens, double-check the file size from the original source. If a file was placed on Contrast's download site but is corrupt, don't hesitate to log a ticket with our Support Team for remediation.

Agent Version Is Lower than the Last Contrast Agent

The service that handles agent updates is designed to look for the latest agent based on build number. If you place an older agent in this directory, the agent probably won't be accessible for download from the Contrast application.

Uninstalling Contrast

If you ever need to remove Contrast from one of your servers, these basic instructions will help you safely and cleanly remove the installation.

Run the Script

Each installation comes with a script for safely uninstalling Contrast and all embedded components such as Java, Tomcat and MySQL. The script is packaged in the root directory of the Contrast installation. On Unix, the file is an executable script labeled uninstall. On Windows, a command file is packaged in the installation directory called uninstall.cmd.

Contrast recommends that you complete the following steps before beginning the uninstallation process:

  • Create a backup of MySQL using the database backup tool provided with Contrast.
  • Shut down Contrast using either the Windows or Unix service script.

Windows

To uninstall Contrast on Windows:

  1. Open the Windows Explorer.
  2. Navigate to the Contrast installation directory.
  3. Click on the file uninstall.exe. If you installed Contrast as an Administrator, you should also run the file using that role. If not, run the file in your current role.
  4. Follow the prompts to complete uninstallation.

Linux

To uninstall Contrast on Linux:

  1. Open a Linux console.
  2. Change directory (cd) to the Contrast installation directory.
  3. Execute the command uninstall.
  4. Follow the prompts to complete uninstallation.

Some Files Will Remain

You'll delete the vast majority of files during the uninstall. However, a few key files will be left on the system, which an Administrator can manually delete.

Note: The uninstaller will not delete the following:

  • The Contrast Home directory
  • The Contrast DATA directory
  • The Contrast LOGS directory
  • The Contrast MYSQL directory