📘

Naming Your Application and Deployment

Naming your applications and deployment allows us to aggregate your data and to sort, view, and compare them from version over version. The data then feeds into our dashboards (without using a naming convention your data loses value):

  • Give the application a name you'll be able to easily track
  • Give your deployment a distinct name so that whenever you deploy new code to your application, you'll be able to distinguish between different deployments that will show up in the OverOps Dashboard.

Use these arguments for the application name and deployment name:
-Dtakipi.application.name=<APPLICATION_NAME>
-Dtakipi.deployment.name=<DEPLOYMENT_NAME>

For Tomcat specifically, you'll need to add theapplication.name to the export CATALINA_OPTS … variable (see Linux/macOS for details).

To learn more, see Naming the Application, Server, Deployment.

📘

Attaching the OverOps Agent to a JVM Running Java 10 or 11

When attaching an OverOps Agent to a JVM that is running Java 10 or 11 or any IBM java versions, follow these guidelines:

  1. Turn off Class Sharing: This can be done using the following flags:
    for IBM Java
    ‑Xshareclasses:none
    for HotSpot
    -Xshare:off -XX:-UseTypeSpeculation

  2. Increase ReservedCodeCache to at least 512mb by adding the following flag
    -XX:ReservedCodeCacheSize=512m

  3. The Agent should appear last in the VM arguments list before specifying the main class or jar.

  4. When adding/removing 3rd party packages, the Agent should be restarted.

Additionally, if you wish to upgrade your own compiler to target Java 10/11, then you'll have to upgrade your Collector (SaaS) or Collector + backend (On-Premises) to support it.

When OverOps is installed on your machine, connect it to your Tomcat server.

🚧

Rootless Agent Installation Method (Linux only)

When Using the Rootless Agent Installation Method replace the
-agentlib:TakipiAgent JVM startup Argument
with
-agentpath:<TAKIPI_HOME>/lib/libTakipiAgent.so JVM startup Argument

Linux/macOS

To connect OverOps to Tomcat running on Linux/macOS:

  1. Locate the catalina.sh file used to run Tomcat.
  2. If it doesn’t already exist, create a setenv.sh file in the same folder.
  3. Add the following line to the end of setenv.sh file:
    CATALINA_OPTS="$CATALINA_OPTS -agentlib:TakipiAgent"

Defining CATALINA_OPTS variable should be run in the terminal instead: export CATALINA_OPTS="$CATALINA_OPTS -agentlib:TakipiAgent"

  1. Restart Tomcat.
  2. Test your Installation

Windows

  1. Locate the catalina.bat file used to run Tomcat.
  2. If it doesn’t already exist, create a setenv.bat in the same folder.
  3. Add the following line to the setenv.bat file before the rem Execute Java with the applicable properties line:
    set CATALINA_OPTS=%CATALINA_OPTS% -agentlib:TakipiAgent
  4. Restart Tomcat.
  5. Test your Installation.

Windows Service

Apache Tomcat has a configuration application which allows you to specify JVM arguments for the server when running as a service.

To add the OverOps agent to Tomcat (Windows):

  1. In the Start menu, from All programs, select Apache Tomcat (version), and click Configure Tomcat.

📘

Note

On Windows Server 2012 + use the following command to edit the Service Properties:
tomcat8w.exe //ES//<service_name>

  1. From the Apache Tomcat Properties, switch to the Java tab and in the Java Options field, add:
    -agentlib:TakipiAgent.
434
  1. Click Apply and then OK.
  2. Restart your machine.
  3. Test your Installation

Application Plugins

Tomcat-Eclipse Plugin

To connect OverOps to Tomcat:

  1. From Eclipse, click Run and select Debug Configurations.
  2. From the Debug Configurations dialog box, select Apache Tomcat and then click the relevant .
  3. From the Arguments tab, in the VM arguments field, add:
    -agentlib:TakipiAgent

or respectively

-agentpath:<TAKIPI_HOME>/lib/libTakipiAgent.so

798
  1. Click Apply and then Close.
  2. Restart Tomcat.
  3. Test your Installation

Tomcat-IntelliJ Plugin

  1. From IntelliJ, open Edit Configurations.
243
  1. From Run/Debug Configurations, in the VM options field,
    add: -agentlib:TakipiAgent

or respectively

-agentpath:<TAKIPI_HOME>/lib/libTakipiAgent.so

1432
  1. Click OK.
  2. Restart Tomcat.
  3. Test your Installation

Tomcat-NetBeans Plugin

  1. From NetBeans, from the Services window (Window | Services), click Servers.
  2. Right click the Apache Tomcat server and select Properties.
  3. In the Server Properties dialog box, switch to the Platform tab.
  4. In the VM Options field,
    add: -agentlib:TakipiAgent

or respectively

-agentpath:<TAKIPI_HOME>/lib/libTakipiAgent.so

752
  1. Click Close.
  2. Restart Tomcat.
  3. Test your Installation