Naming Conventions



Naming the Application

Naming the Server

Naming the Deployment

Related Articles


Naming the Application

The Dashboard allows you to filter events from specific servers or applications. An application is defined as a group of JVMs sharing the same logical name (e.g. "consumer-service", "data-provider").

To assign an application name to any monitored JVM:

  1. On startup, add the following JVM argument:<APPLICATION_NAME>

Once the application is named, OverOps attaches it to every event thrown in this application, so you can filter and view relevant error data. To filter errors from this application, check it in the Servers/Apps filters menu:

Filtering the Dashboard to visualize data from specific applications or machines


Naming the Server

OverOps automatically detects the names of the servers based on their IP address, and allows you to filter errors originating from specific machines. If you want to change those names and send OverOps different titles for your servers, you can do so by running this command:

  sudo /opt/takipi/etc/takipi-setup-machine-name <YourMachineName>

Please restart your OverOps daemon for changes to take effect. You can assign the same name to multiple machines, essentially grouping them under a combined "logical" machine name (e.g. "SparkCluster").

Once you've named your JVMs and/or machines you can then easily filter the dashboard to show only data coming from those sources, or even create specific views to show things such "new errors today in app X" or "AWS errors from machine Y".

Naming the Deployment

OverOps allows you to filter dashboard data by your different code versions and deployments. Whenever you deploy new code to your application, you can mark the deployment with a distinct name that will show up in the OverOps dashboard and allow you to view errors coming from this version of the code only, to see which errors originated from the deployment, and more.

There are two ways to name your deployment:

  1. Using a JVM argument passed to your application at start-up
  2. Using a JAR manifest attribute within your packaged application JAR/WAR

Naming the deployment using a JVM argument

As the application, you can name the deployment by adding a JVM argument to the application command line:<DEPLOYMENT_NAME>

A JVM restart is required for the new deployment name to take effect.

Naming the deployment using a JAR or WAR manifest attribute

If you prefer to bundle the deployment name with the deployed artifacts (for example, during your build process), you can do so by adding a line to your artifact's JAR or WAR manifest. The JAR/WAR manifest is a textual metadata file within your application's JAR/WAR file which describes different properties of your application. You can read more here.

In order to name your deployment via your JAR/WAR's manifest, add the following attribute to the file:

  Takipi-Deployment-Name: <YourDeploymentName>

This method does not require a JVM restart, but the attribute must be read before the JVM loads the new JAR/WAR file and its contained bytecode into memory.


Related articles

Dashboard Views


0 out of 0 found this helpful



Please sign in to leave a comment.