Application Real-Time Monitoring Service (ARMS) allows you to configure the settings of the application monitoring feature on the Custom Configurations tab. The configurable settings include the sampling rate of traces, agent switch, and the threshold of slow SQL queries.

Procedure

  1. Log on to the ARMS console .
  2. In the left-side navigation pane, choose Application Monitoring > Applications. In the top navigation bar, select a region.
  3. On the Applications page, click the name of the application for which you want to configure settings.
  4. In the left-side navigation pane, click Application Settings. On the page that appears, click the Custom Configurations tab.
  5. Set the parameters as required and click Save in the lower part of the page.

Configure trace sampling settings

ARMS Trial Edition and Pro Edition

In the Invocation Trace Sampling Settings section, you can turn on or turn off Enable Sampling and specify a sampling rate. In the Sampling Rate Settings field, enter a percent value. For example, if you enter 10, the sampling rate is 10%.

Notice The modifications take effect immediately. You do not need to restart the application. If you turn off Enable Sampling, the trace data is no longer captured. Proceed with caution.
Chain sampling

ARMS Basic Edition

ARMS Basic Edition supports setting client sampling policies. You are billed based on the number of lines of data collected. By default, each ARMS agent collects one trace per minute for each API in your account free of charge. You can add custom sampling policies based on your business requirements.

Table 1. Client sampling policy settings
Parameter Description
Sampling Policy Name The name of the sampling policy.
Sampling Type and Value
  • Fixed Ratio Sampling: Traces are sampled based on a specified fixed ratio. After you select this option, you must enter a ratio in the Value field, such as 10%.
  • Traffic Limit: A specified number of traces are sampled within a specified time interval. After you select this option, you must set the number of traces to be collected by each agent and the time interval. For example, 5 traces are collected by each agent every 1 second.
Effective Scope The range of APIs to which the sampling policy applies. Valid values: All Interfaces or Specified Interface. If you select Specified Interface, you must enter an API name.
Note If you select Specified Interface, you can enter only one API name. If you want to specify multiple APIs, you must set a sampling policy for each API.

After you set a sampling policy, you can select whether to enable the policy in the console. If multiple sampling policies are enabled, the policies take effect in the following order of priority: default sampling (free of charge) > traffic limit (a specified API) > fixed ratio sampling (a specified API) > traffic limit (all APIs) > fixed ratio sampling (all APIs). You can also modify the settings of a sampling policy or delete a sampling policy.

The sampling policy of ARMS Basic Edition

Configure the agent switch and log level

In the Agent Switch Settings section, you can turn on or off the switch of the ARMS agent and the switches of different plug-ins, and configure the log level.

Notice The modifications to the ARMS agent and log level take effect immediately. You do not need to restart the application. If the switch of the ARMS agent is turned off, ARMS cannot monitor the application. Proceed with caution. To make the modification to each plug-in switch take effect, you must manually restart the application.
Agent Switches

Configure threshold settings

In the Threshold Settings section, you can configure the thresholds of slow SQL queries, API response time, and throttling.

Threshold Settings

Configure advanced settings

In the Advanced Settings section, you can configure advanced settings, including the API operations to be filtered out and the maximum length of the method stack.

Advanced Settings
  • Invalid Interface Invocation Filtering: Enter the APIs whose statistics you do not want to view. After the modification is saved, the specified API operations are hidden on the Interface Invocation page.
  • Method stack maximum length: Specify the maximum length of a method stack. Default value: 128. Maximum value: 400. The value indicates the number of entries.
  • Stack depth to distinguish same exception: Specify the stack depth that is used to distinguish exceptions of the same type. Generally, this parameter is set to the call depth of the first difference.
  • Collect the maximum length of SQL: Specify the maximum length of a SQL statement. Default value: 1024. Valid values: 256–4096. The value indicates the number of characters.
  • Collect SQL Bindings: Specify whether to capture the variable value bound to the PrepareStatement parameter. The modification takes effect immediately. You do not need to restart the application.
  • Raw SQL: Specify whether to perform operations other than truncation on SQL statements.
  • Whitelist: Specify the exceptions that are not displayed in the charts on the application details page and Exception Analysis tab.
  • Error Code Filter: By default, all HTTP status codes greater than 400 are counted as errors. To ignore specific HTTP status codes greater than 400, you can specify them in value.
  • Trace Storage: Specify whether to use the new storage format that sorts traces by time. By default, this switch is turned on.
  • Inner Callstack Reduce: Specify whether to simplify duplicated calls such as for loops. The modification takes effect immediately. You do not need to restart the application.
  • Max Length of Input Parameters: Specify the maximum length of an input parameter value. Default value: 512. Maximum value: 2048. The value indicates the number of characters.
  • Quantile Statistics: Specify whether to enable quantile statistics.
  • RabbitMQ Custom Consumer: Specify the class name of a custom consumer or the name of the class that contains an anonymous internal consumer. Then, you can view the trace of the customer. You can specify multiple class names and separate them with commas (,).
  • Thread pool monitoring: Specify whether to monitor thread pool metrics in frameworks such as Apache Tomcat, Apache Dubbo, and High-speed Service Framework (HSF). To enable this feature, the ARMS agent must be updated to the latest version. You must restart the application to apply the modification.
  • Asynchronous transparent transmission scan package name: You can add a scan package for asynchronous pass-through to the configurations of your application to monitor asynchronous tasks. After a Runnable object, a Callable object, or a Supplier object is created, the corresponding method in the scan package for asynchronous pass-through automatically captures the trace context of the current thread. Then, when threads are used in asynchronous mode, the method passes the captured trace context to the threads. The version of the ARMS agent must be v2.7.1.3 or later.
  • TraceId is returned in the request: Specify whether to return the eagleeye-traceid field in the response headers for HTTP requests.

Configure thread settings

In the Thread settings section, you can turn on or turn off the switch of the thread diagnostics method stack and the switch of thread profiling. You can specify a threshold to trigger slow call listening.

Thread Settings
Note The listener is triggered when the response time of a service call exceeds the threshold and lasts until the call ends or the time consumed exceeds 15 seconds. The default threshold is 1,000 milliseconds. We recommend that you set the threshold to the 99th percentile of the call response time. For example, if 100 calls are sorted in ascending order by response time, the amount of time consumed by the 99th call is the 99th percentile.

Associate business logs with trace IDs

In the Business Log Linking Settings section, you can specify whether to associate the business logs of the application with trace IDs. For more information, see Associate trace IDs with business logs.
Note Only the Application Monitoring Pro Edition supports this feature.
Business log

Configure URL convergence rules

In the URL Aggregation section, you can enable or disable the convergence feature. You can also set the convergence threshold, convergence rules, and troubleshooting rules. URL convergence means that similar URLs are displayed together as a single object. For example, URLs prefixed with /service/demo are displayed as an object. The convergence threshold is the minimum number of URLs required to trigger URL convergence. For example, if the threshold is set to 100, URLs are converged only when 100 URLs meet the regular expression of the rules.

URL Aggregation

Configure business monitoring

In the Scenario settings section, you can enable or disable business monitoring and specify an HTTP encoding format.

Business monitoring

Configure Arthas monitoring

In the Arthas monitoring section, you can enable or disable the Arthas diagnostics feature. You can also specify the IP addresses on which you want to perform Arthas diagnostics. For more information, see Arthas diagnostics (new).

Note Only the Application Monitoring Pro Edition supports this feature.
Custom Configurations - Arthas monitoring

Configure log analysis

In the Log Analysis Settings section, you can turn on or turn off Automatic Log Collection, select the log severity, and set the maximum size of a single log. For more information, see Log analysis (new).

Custom Configurations - Log Analysis Settings