Add custom methods for monitoring - Application Real-Time Monitoring Service

The Application Real-Time Monitoring Service (ARMS) agent automatically instruments common frameworks and methods. If your application uses custom business logic or an unsupported framework, some methods may not appear in trace data. Add custom methods to capture these undetected methods in your traces -- no code changes required.

When to add custom methods

Add custom methods in these situations:

A method you need to monitor is not automatically instrumented by the ARMS agent.
You need finer-grained visibility into specific business logic, such as order processing or payment handling.
Trace data shows gaps where internal method calls lack sufficient detail.

Note

If a method belongs to a supported framework but does not appear in traces, verify that the ARMS agent is installed and configured correctly before adding it as a custom method.

Prerequisites

Before you begin, make sure that you have:

An ARMS agent installed for the application. For more information, see Application Monitoring overview

Important

Application Monitoring provides a new application details page for users who have enabled the new billing mode. For more information, see Billing (new). If you have not enabled the new billing mode, click Switch to New Version on the Application List page to access the new application details page.

Add a custom method

Log on to the ARMS console. In the left-side navigation pane, choose Application Monitoring > Application List.
On the Application List page, select a region in the top navigation bar, and then click the name of the application that you want to manage.
Note
If the icon is displayed in the Language column, the application is connected to Application Monitoring. If a hyphen (-) is displayed, the application is connected to Managed Service for OpenTelemetry.
In the top navigation bar, choose Configuration > Custom Monitoring Methods.
Click Add Method.

In the Add Custom Method dialog box, configure the following parameters, and then click OK.

Note

If you mark multiple custom methods as entry points within the same call stack, ARMS collects monitoring data only for the last method in the chain. For example, if Function A calls Function B and both are configured as entry points, ARMS collects monitoring data only for Function B.

Parameter	Description
Method	The name of the method to monitor. The method name must be unique.
Enable	Enables or disables monitoring for this method. When enabled, the method appears in the local method stack in trace data. For more information, see Trace query. Turned on by default. This feature can be enabled or disabled without restarting the application.
Call Entrance	Marks this method as an entry point for request traces. When enabled, you can query business by traces, and the corresponding interface appears on the Provided Services tab. For more information, see Services provided. Turned off by default.

Verify the result

After you add a custom method:

Query and analyze traces to verify that the custom method appears in your trace data.
If you enabled Call Entrance, check the Services provided tab to confirm that the entry method is listed.