doc.overops.com

Using Exception Tiny Links

Introduction

Exception Tiny Links are short URLs that are injected into an exception object and direct users to the exact event snapshot within the OverOps Automated Root Cause screen without having to provide the complete link.

By enabling Exception Tiny Links, you'll get tiny links inserted into the actual exception object, which make them easy to share and track; if they're not enabled, tiny links won't be attached to the exceptions.

Here's an example of a logged exception:

[2019-03-20 14:10:30 TAKIPI] New issue detected. java.lang.IndexOutOfBoundsException: Throwing a test exception: IndexOutOfBoundsException [ http://tkp.to/hgAdqlNk ] at Main.Main.Throwing(Main.java:49) at Main.Main.main(Main.java:19)

What to Consider Before Turning this Feature On?

From version 4.9.0 and above, Exception Tiny Links are turned off by default and can be enabled by administrators and key owners only. Before you decide to use these links, make sure that your system can support them and take into consideration the following:

  • Some frameworks and systems parse the exception object, and the Exception Tiny Link changes the message.
  • Additionally if you're using JSON exceptions, Exception Tiny Links will cause these exceptions to fail due to a malformed JSON
  • The Tiny Link will appear anywhere you show the exception. For example, if you return the exception error message to your UI, the link will be shown.

Prerequisites

To use Exception Tiny Links you'll need to do the following:

  • Step 1: Enable Exception Tiny Links
  • Step 2: For On-Premises deployments only - set the short URL prefix

Step 1: Enabling (and Disabling) Exception Tiny Links

There are two options for enabling tiny links - through the OverOps Settings dashboard or through the agent.properties file.

Enabling and Disabling Exception Tiny Links through the Settings Dashboard

Important

Enabling/Disabling Exception Tiny Links through the Settings Dashboard is currently limited for Java applications only.

Best Practice

When you enable Exception Tiny Links through the agent.properties, this applies your changes to a specific Micro-Agent; and therefore, we recommend using this method especially if you're using Java 6, 7, 8, or 9.

  1. In the upper right corner of the web application select Settings and in the Settings dashboard, select Advanced under the General Settings section (you'll need to be an administrators or key owner).
  1. Select the checkbox "Show log links" and then click Apply to save your changes.
  2. To disable Exception Tiny Links, follow the steps above and clear the relevant checkbox.

Enabling Exception Tiny Links through the Micro-Agent Properties File

  1. Open the Micro-Agent properties file and add the following line: takipi.etl=1.
  2. To disable, simply remove the takipi.etl=1 line.
    For more information refer to agent.properties file

Step 2: Setting the Short URL Prefix for On-Premises Deployments (Only)

The best way to set up the short URL prefix depends on whether you're using Java 6, 7, 8, or 9 or Java 10, 11, or J9.

For Java 6, 7, 8, or 9

  1. Open the agent.properties file.
  2. In the parametertakipi.short.url.prefix, specify the URL (the parameter lets you set the base URL for tiny links locally on the fly).

Mandatory Setting

The short URL prefix setting is mandatory and must be set to ensure that the feature works correctly.

For Java 10 or 11 or J9

  1. Open the agent.properties file.
  2. In the parameter short_url_prefix set the parameter to the exact URL. This value will be sent to all connected agents upon successful connection.

Updated about a month ago

Using Exception Tiny Links


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.