Naming Your Application, Servers and Deployments

Contents

Naming your application

Naming your server

Naming your deployment

Related articles

 

Naming your application

After your installation is complete, the dashboard allows you to filter errors coming from a specific server or from a specific application. 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 simply add this JVM argument on start up:

  -Dtakipi.name=<YourApplicationName>

Once your application has a name, OverOps will add it to each error thrown in this app, so you can filter and view relevant error data. To see errors only from the app in question, simply select the desired application from the Server/Apps filters menu:

Filter the dashboard to visualize data from specific applications or machines.

 

Naming your server

OverOps automatically detects the names of your 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 your 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 your deployment using a JVM argument

Similar to how you would name your application, you can name your deployment by adding a JVM argument to your application's command line:

  -Dtakipi.deployment.name=<YourDeploymentName>

You will need to restart the JVM for the new Deployment Name to take effect.

 

Naming your deployment using a JAR or WAR manifest attribute

If you prefer to bundle your deployment name with your 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

 

Have more questions? Submit a request