Schedule demo

Custom instrumentation using Web Client


By default, the APM Insight agent instruments application transactions, supported classes and methods, and web frameworks. To minimize overhead on the application, certain methods and frameworks are not instrumented by default.

Custom instrumentation allows you to configure additional methods, classes, or frameworks for monitoring, providing greater visibility into application performance and transaction traces.

When to use custom instrumentation

Custom instrumentation is useful in the following scenarios:

  • When you need greater visibility into application methods and frameworks that are not instrumented by default.
  • When transaction traces contain an Uninstrumented block of code, and you need to investigate the performance of the corresponding method or class.
  • When your application uses a framework that is not instrumented by default.

Note: Web Client custom instrumentation is supported only for Java and .NET Core agents. For Ruby and Node.js applications, use the respective agent APIs to configure custom instrumentation: Ruby and Node.js.
These configurations apply to all instances of an APM Insight application. To configure instance-specific custom instrumentation, use the Java agent API or .NET agent API, depending on your application platform.

Configuring custom instrumentation using the Web Client

Follow these steps to configure custom instrumentation:

  1. Log in to the Applications Manager web client.
  2. Go to the APM tab → Your application → Edit APM Insight Application Configuration.
  3. In the Custom Instrumentation section, select the TEXT or JSON format and enter the custom instrumentation configuration in the text box. Refer to the examples below for the syntax of each format.

    JSON format

    Use the following syntax to specify the fully qualified class name, method names, and component name:

    Format:
    {
      "Fully qualified ClassName": {
        "MethodName1": "ComponentName",
        "MethodName2": "ComponentName"
      }
    }
    Example:
    {
      "com.sample.web.tasks.ModelUpdateHandler": {
        "doHandle": "MODEL_UPDATE",
        "update": "MODEL_UPDATE"
      }
    }

    Use Beautify JSON to format the JSON input and Reset to clear your changes.

    Text format

    Use the following syntax to specify the fully qualified class name, method names, and component name. Separate the method names with commas.

    Format:
    Fully qualified ClassName : methodNames separated by comma(,) : Component Name
     
    Example:
    com.sample.web.tasks.ModelUpdateHandler : doHandle, update : MODEL_UPDATE
    com.sample.web.services.SystemCheck : doCheck, isHealthy :
    com.sample.web.store.DataModifier : : MODIFIER
    com.sample.web.utils.FileUtils : :

    Note: Specify fully qualified class names in the following formats:
    Java:com/appmanager/apminsight/agent/JavaAgent
    .NET Core:Com.Appmanager.Apminsight.Agent.DotAgent

  4. After entering the configuration, click Save.

 Applications Manager APM Insight Custom Instrumentation configuration using the Web Client

Example: Before and after custom instrumentation

The following screenshots illustrate the transaction trace before and after custom instrumentation with the Java agent.

Before:

Java agent transaction trace before custom instrumentation

After:

Java agent transaction trace after custom instrumentation

Loved by customers all over the world

"Standout Tool With Extensive Monitoring Capabilities"

★★★★★

It allows us to track crucial metrics such as response times, resource utilization, error rates, and transaction performance. The real-time monitoring alerts promptly notify us of any issues or anomalies, enabling us to take immediate action.

Reviewer Role: Research and Development

carlos-rivero
"I like Applications Manager because it helps us to detect issues present in our servers and SQL databases."
Carlos Rivero

Tech Support Manager, Lexmark

Trusted by thousands of leading businesses globally