- Enable APM.
- Log in to the APM console.-
If you log in to the APM console for the first time, you can choose the free or enterprise edition. For more information, see Edition Differences.
- - Click
on the left and choose Application > Application Performance Management.
- Enable APM.
- Log in to the APM console.
If you log in to the APM console for the first time, you can choose the free or enterprise edition. For more information, see Edition Differences.
+ - Click on the left and choose Application > Application Performance Management.
- Log in to the APM console.
- Obtain the access key that is automatically created.
APM uses AK/SK for signature verification. Only authorized accounts can report data.
- Log in to the APM console.
- In the navigation pane, choose System Management > Access Keys.
- On the Access Keys page, view the access key that has been automatically created.
Connecting Agents
-Prerequisites
The network between your host and APM is normal.
-You can run the Telnet command to check the network.
-+
Java supports enhanced Agents.
--Prerequisites
- The network between your host and APM is normal. You can run the Telnet command to check the network.
- Java supports enhanced Agents.
Procedure
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Applications.
- On the displayed page, click Connect Application.Figure 1 Connecting an application+
Procedure
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Applications.
- On the displayed page, click Connect Application.Figure 1 Connecting an application
- Select a region and application. Click Create Application. In the dialog box that is displayed, create an application by referring to Creating an Application.Figure 2 Basic information-
- Select Java for Backend language.Figure 3 Access mode-
- Select Enhanced Agent for Code Source.
- Use a remote login tool, such as PuTTY, to log in to the Linux host where the Agent is to be installed and run related commands as the root user.
- Select an access mode based on the application type and access data by following the instructions.Figure 4 Data access+
- Select Enhanced Agent for Access Mode.
- Select Java for Backend Language.Figure 3 Access mode+
- Use a remote login tool, such as PuTTY, to log in to the Linux host where the Agent is to be installed and run related commands as the user with the root or service permissions.
- Select an access mode based on the application type and access data by following the instructions.Figure 4 Data access
Table 1 Parameter description Parameter
APM_AK
APM_SK
AK and SK for installing JavaAgent.
-CAUTION:+When you copy the command to install JavaAgent, delete {} when setting APM_AK and APM_SK.
-AK and SK for installing JavaAgent. To obtain APM_AK and APM_SK, see Access Keys.
+When you copy the command to install JavaAgent, delete {} when setting APM_AK and APM_SK.
+Example:
+curl -k https://javaagent.***/apm_agent_install2.sh -o apm_agent_install.sh && bash apm_agent_install.sh -ak * -sk * -masteraddress https://**** -obsaddress https://javaagent.***.com -version latest; history -cw; history -r
Yes
Example of adding -javaagent parameters:
java -javaagent:/xxx/apm-javaagent/apm-javaagent.jar=appName={appName}
If your enterprise has a large number of services, you can add more complex configurations. For example:
-java -javaagent:/xxx/apm-javaagent/apm-javaagent.jar=appName=myApp,env=myEnv,envTag=myTag,business=myBusiness,subBusiness=mySub+- - The preceding parameters are built-in CMDB information of APM. For details, see CMDB Management.
- Due to historical reasons, the metadata of APM startup parameters conflicts with some CMDB concepts. The following shows the details.
Generally, the startup parameter is set to -javaagent:D:\javaagent-package\apm-javaagent\apm-javaagent.jar=appName=xxx,env=yyy,business=zzz,subBusiness=sss,envTag=xxx. appName indicates a component, business indicates an application, subBusiness indicates a sub-application, and envTag indicates an environment tag.
+java -javaagent:/xxx/apm-javaagent/apm-javaagent.jar=appName=myApp,env=myEnv,envTag=myTag,business=myBusiness,subBusiness=mySub
+- The preceding parameters are built-in CMDB information of APM. For details, see CMDB Management.
- Due to historical reasons, the metadata of APM startup parameters conflicts with some CMDB concepts. The following shows the details.
Generally, the startup parameter is set to -javaagent:D:\javaagent-package\apm-javaagent\apm-javaagent.jar=appName=xxx,env=yyy,business=zzz,subBusiness=sss,envTag=xxx. appName indicates a component, business indicates an application, subBusiness indicates a sub-application, and envTag indicates an environment tag.
If business is not set on the web page, the system reports an error when the JavaAgent is started. If other parameters (subBusiness, appName, env, and envTag) are not set, the system automatically creates them when the JavaAgent is started.
Component names are unique under an application.
- Redeploy the application.
diff --git a/docs/apm/umn/apm_02_0005.html b/docs/apm/umn/apm_02_0005.html index d35f70e6c..876a29bcf 100644 --- a/docs/apm/umn/apm_02_0005.html +++ b/docs/apm/umn/apm_02_0005.html @@ -1,64 +1,62 @@Installing Agents for the Java Applications Deployed in CCE Containers
-- - You are advised to install self-developed Agents for the Java applications deployed in CCE containers.
Prerequisites
- The network between your host and APM is normal.
You can run the Telnet command to check the network.
+Prerequisites
- You are advised to install self-developed Agents for the Java applications deployed in CCE containers.
- The network between your host and APM is normal.
- For details, see Regions and Endpoints.
- The AK/SK required for accessing JavaAgents have been obtained. To obtain them, log in to the APM console and choose System Management > Access Keys in the navigation pane.
+Figure 1 Obtaining an AK/SK
Usage Instruction
APM only supports Java applications deployed on CCE. Table 1 describes the parameters.
-Table 1 Parameters for configuring performance management Name
+-Table 1 Parameters for configuring performance management Name
Description
+Description
Probe
+Probe
Select a target probe. Options: Disable/APM probe.
+Select a target probe. Options: Disable/APM probe.
Probe Version
+Probe Version
Version of the probe. You are advised to select a probe type based on the CPU architecture of the node where the workload is located.
+Version of the probe. You are advised to select a probe version based on the CPU architecture of the node where the workload is located.
Probe Upgrade Policy
+Probe Upgrade Policy
Policy for the probe upgrade. The default value is Auto upgrade upon restart.
+Policy for the probe upgrade. The default value is Auto upgrade upon restart.
- Automatic upgrade upon restart: The system downloads the probe image each time the pod is restarted.
- Manual upgrade: If a local image is available, it will be used. If no local image is available, the system downloads the probe image.
APM Environment
+APM Environment
Enter an APM environment name. This parameter is optional.
+Enter an APM environment name. This parameter is optional.
APM App
+APM App
Select an existing APM application.
+Select an existing APM application.
Sub-app
+Sub-app
Enter an APM sub-application. This parameter is optional.
+Enter an APM sub-application. This parameter is optional.
Access Key
+Access Key
The system automatically obtains the APM key. For details, see Prerequisites.
+The system automatically obtains the APM key. For details, see Prerequisites.
+ + \ No newline at end of file diff --git a/docs/apm/umn/apm_07_0001.html b/docs/apm/umn/apm_07_0001.html index 117fac1bf..b20554032 100644 --- a/docs/apm/umn/apm_07_0001.html +++ b/docs/apm/umn/apm_07_0001.html @@ -27,7 +27,8 @@Procedure
- Log in to the CCE console. In the navigation pane, choose Workloads > Deployments or StatefulSets, and click Create Deployment or Create StatefulSet.
- In the APM Settings area on the Configure Advanced Settings page, select Java probe. The APM service will be enabled and a probe will be installed on the node.+
Probes provide traces, topologies, SQL analysis, and stack tracing for Java workloads. A small number of resources will be consumed when you run probes.
-Procedure
- Log in to the CCE console. In the navigation pane, choose Workloads > Deployments or StatefulSets, and click Create Deployment or Create StatefulSet.
- In the APM Settings area on the Configure Advanced Settings page, select Java probe. The APM service will be enabled and a probe will be installed on the node.
Probes provide traces, topologies, SQL analysis, and stack tracing for Java workloads. A small number of resources will be consumed when you run probes.
- Set probe-related parameters.
- Monitoring Group: Enter a monitoring group name, for example, testapp. Select a group from the drop-down list if there are any.
- Probe Version: Select a probe version.
- Probe Upgrade Policy: By default, Automatic upgrade upon restart is selected.
- Automatic upgrade upon restart: The system downloads the probe image each time the pod is restarted.
- Manual upgrade: If a local image is available, it will be used. If no local image is available, the system downloads the probe image.
- After the application is started, wait for about 3 minutes. Then, the application data is displayed on the APM console. You can log in to the APM console and optimize the application performance through topology and tracing.
The call and dependency relationships between applications are displayed, and abnormal instances can be automatically discovered.
There are two types of application topologies:
-- Single-component topology: topology of a single component under an environment. You can also view the call relationships of direct and indirect upstream and downstream components.
- Global application topology: topology of some or all components under an application.
Single-component topology: topology of a single component under an environment. You can also view the call relationships of direct and indirect upstream and downstream components.
+Global application topology: topology of some or all components under an application.
@@ -47,14 +48,17 @@ Configuration Management manages and displays the configurations supported by APM in a centralized manner. It consists of two parts:
-- Collection Center: displays collectors in a centralized manner. You can view and manage various collectors, metrics, and collection parameters supported by APM.
- Data Masking: You can set policies to mask the data reported using APM APIs.
Configuration Management manages and displays the configurations supported by APM in a centralized manner. It includes:
+Collection Center: displays collectors in a centralized manner. You can view and manage various collectors, metrics, and collection parameters supported by APM.
+Data Masking: You can set policies to mask the data reported using APM APIs.
System Management manages and displays system configurations in a centralized manner, including:
-- Access Keys: long-term identity credentials. They ensure that the requests are secret, complete, and correct.
- General Configuration: system general configuration. You can determine whether to collect data through bytecode instrumentation, specify the slow request threshold and maximum number of rows to collect, and set web monitoring aggregation.
- Agent Count: APM counts the number of Agents used by tenants.
System Management manages and displays system configurations in a centralized manner. It includes:
+Access Keys: long-term identity credentials. They ensure that the requests are secret, complete, and correct.
+General Configuration: system general configuration. You can determine whether to collect data through bytecode instrumentation, and specify the slow request threshold and maximum number of rows to collect.
+Agent Count: APM counts the number of Agents used by tenants.
diff --git a/docs/apm/umn/apm_07_0002.html b/docs/apm/umn/apm_07_0002.html index 4c6a75b04..a33479b05 100644 --- a/docs/apm/umn/apm_07_0002.html +++ b/docs/apm/umn/apm_07_0002.html @@ -2,8 +2,8 @@ Application List
Application List
The Applications page displays information such as components, environments, Agent status, and supported operations.
-- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane on the left, choose Application Monitoring > Applications.Figure 1 Application list-
Component|Environment: name of a component or environment. You can click the text in blue to go to the corresponding to component or environment page.
+- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane on the left, choose Application Monitoring > Applications.Figure 1 Application list+
Component|Environment: name of a component or environment. You can click the text in pink to go to the corresponding to component or environment page.
Agent Status: number of Agents in different statuses.
The following table describes the Agent statuses.
diff --git a/docs/apm/umn/apm_07_0003.html b/docs/apm/umn/apm_07_0003.html index 5fa10b797..140931ab8 100644 --- a/docs/apm/umn/apm_07_0003.html +++ b/docs/apm/umn/apm_07_0003.html @@ -4,7 +4,7 @@-
-
- Overview
+ - Introduction
- Application Monitoring Details
diff --git a/docs/apm/umn/apm_07_0004.html b/docs/apm/umn/apm_07_0004.html
index 403c36521..77c388674 100644
--- a/docs/apm/umn/apm_07_0004.html
+++ b/docs/apm/umn/apm_07_0004.html
@@ -1,16 +1,15 @@
- - Collection period: A monitoring item has the same period attribute as a data collector. The default data collection period is 1 minute and cannot be changed.
- Monitoring item status: A monitoring item is enabled by default. You can disable it so that an Agent does not intercept or report the metric data. For details, see Enabling or Disabling a Monitoring Item.
- Collection status: Each collection instance or monitoring item has a collection status. If a collection error occurs, you can view it on the Collection Status tab page. A common error is that there are too many primary keys. As a result, data aggregation on the client is abnormal.
- Topology: Displays the call relationships between services within a period. The statistics can be collected from the caller or the callee. You can also check the trend.
- URL: Monitors the external services that call the current application.
- JVM: Monitors basic system performance metrics.
- Exception: Monitors application exceptions.
- Call: Monitors the external services called by the current application.
- SQL: Monitors database access.
- Web Container: Monitors web containers such as Tomcat. Generally, the total number of threads, number of busy threads, and number of connections are collected to measure the overall system capacity.
- Topology: displays the call relationships between services within a period. The statistics can be collected from the caller or the callee. You can also check the trend.
- URL: monitors the external services that call the current application.
- JVM: monitors basic system performance metrics.
- Exception: monitors application exceptions.
- Call: monitors the external services called by the current application.
- SQL: monitors database access.
- Web Container: monitors web containers such as Tomcat. Generally, the total number of threads, number of busy threads, and number of connections are collected to measure the overall system capacity.
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. On the URL tab page that is displayed, check URL monitoring information of all instances.Figure 1 Going to the URL page-
- On the displayed URL tab page, select a target instance and monitoring item to view the monitoring data in different metric sets.Figure 2 Selecting an instance and monitoring item-
- Select a time range. Default: Last 20 minutes.
Options: Last 20 minutes, Last hour, Last 3 hours, Last 6 hours, Last day, Today, Yesterday, Last week, Last month, or Custom.
- - Click
in the upper right corner of the list and select the metric data you want to view. - Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. On the URL tab page that is displayed, check URL monitoring information of all instances. - On the displayed URL tab page, select a target instance and monitoring item to view the monitoring data in different metric sets.
- Select a time range. Default: Last 20 minutes.
Options: Last 20 minutes, Last hour, Last 3 hours, Last 6 hours, Last day, Today, Yesterday, Last week, Last month, or Custom.
+ - Click
in the upper right corner of the list and select the metric data you want to view. - URL invocation is the starting point of tracing. When you click a URL, the tracing page is displayed, showing the URL invocation condition in a certain period (default: 20 minutes).
- You can add a URL for tracing by referring to Configuring URL Tracing.
- Click a number in blue (such as those in the Calls or Avg RT (ms) column) to view more details.
- URL invocation is the starting point of tracing. When you click a URL, the tracing page is displayed, showing the URL invocation condition in a certain period (default: 20 minutes).
- You can add a URL for tracing by referring to Configuring URL Tracing.
- Click a number in pink (such as those in the Calls or Avg RT (ms) column) to view more details.
- Click a status code in the code column. The tracing page is displayed, showing the invocation condition of the status code of the selected instance in the environment in last 20 minutes (default).
- Click a number in the Count column to view the trend of the status code in a specified period.
- Click the latest URL to view the invocation details of the corresponding status code.
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. - Click the JVM tab. By default, the JVMMonitor information of all instances is displayed. Figure 1 Going to the JVM page-
- On the displayed JVM tab page, select a target instance and monitoring item to view the monitoring data in different metric sets.Figure 2 Selecting an instance and monitoring item-
- Select a time range. Default: Last 20 minutes.
Options: Last 20 minutes, Last hour, Last 3 hours, Last 6 hours, Last day, Today, Yesterday, Last week, Last month, or Custom.
+Going to the JVM Page
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. - Click the JVM tab. By default, the JVMMonitor information of all instances is displayed.
- On the displayed JVM tab page, select a target instance and monitoring item to view the monitoring data in different metric sets.
- Select a time range. Default: Last 20 minutes.
Options: Last 20 minutes, Last hour, Last 3 hours, Last 6 hours, Last day, Today, Yesterday, Last week, Last month, or Custom.
Viewing JVM Information
On the JVM tab page, view the JVMInfo metrics of the corresponding instance. For details about the metrics, see Table 1.
-Figure 3 Viewing JVM information-
Table 1 JVMInfo metrics Metric Set
+Table 1 JVMInfo metrics Metric Set
Metric
+Metric
Description
+Description
JVMInfo
+JVMInfo
JavaAgent Version
+JavaAgent Version
Java Agent version.
+Java Agent version.
Started
+Started
JVM startup time.
+JVM startup time.
Startup Parameter
+Startup Parameter
JVM startup parameter.
+JVM startup parameter.
Java Class Library Path
+Java Class Library Path
Java class library path.
+Java class library path.
Java Version
+Java Version
Java version.
+Java version.
Java Specification Version
+Java Specification Version
Java specification version.
+Java specification version.
OS
+OS
OS name.
+OS name.
OS Version
+OS Version
OS version.
+OS version.
arch
+arch
CPU architecture.
+CPU architecture.
Processors
+Processors
Number of processors.
+Number of processors.
SDK Version
+SDK Version
SDK version.
+SDK version.
Viewing JVM Monitoring Data
APM monitors JVM metrics. For details about the metrics, see Table 2. JVM monitoring metrics are displayed in graphs, so that you can view and analyze JVM monitoring data more easily.
-Figure 4 Viewing JVM monitoring data-
Table 2 JVM monitoring metrics Metric Set
+Table 2 JVM monitoring metrics Metric Set
Metric
+Metric
Description
+Description
Thread
+Thread
Current Threads
+Current Threads
Number of current threads.
+Number of current threads.
Deadlock Threads
+Deadlock Threads
Number of deadlock threads.
+Number of deadlock threads.
Daemon Threads
+Daemon Threads
Number of daemon threads.
+Number of daemon threads.
Started Threads
+Started Threads
Number of started threads.
+Number of started threads.
Peak Threads
+Peak Threads
Peak number of threads.
+Peak number of threads.
Thread Status
+Thread Status
Waiting Threads
+Waiting Threads
Number of waiting threads.
+Number of waiting threads.
Terminated Threads
+Terminated Threads
Number of threads in the terminated state.
+Number of threads in the terminated state.
Runnable Threads
+Runnable Threads
Number of runnable threads.
+Number of runnable threads.
Blocked Threads
+Blocked Threads
Number of blocked threads.
+Number of blocked threads.
New Threads
+New Threads
Number of new threads.
+Number of new threads.
Timed Waiting Threads
+Timed Waiting Threads
Number of threads that timed out.
+Number of threads that timed out.
Memory
+Memory
Used Non-Heap Memory
+Used Non-Heap Memory
Size of the used non-heap memory.
+Size of the used non-heap memory.
Used Heap Memory
+Used Heap Memory
Size of the used heap memory.
+Size of the used heap memory.
Used Direct Memory
+Used Direct Memory
Size of the used direct memory.
+Size of the used direct memory.
Class loading
+Class loading
Current Classes
+Current Classes
Number of current classes.
+Number of current classes.
Total Loaded Classes
+Total Loaded Classes
Total number of loaded classes.
+Total number of loaded classes.
Unloaded Classes
+Unloaded Classes
Number of unloaded classes.
+Number of unloaded classes.
Memory pool
+Memory pool
committed(M)
+committed(M)
Size of available memory.
+Size of available memory.
init(M)
+init(M)
Size of the initialized memory.
+Size of the initialized memory.
max(M)
+max(M)
Size of the maximum memory.
+Size of the maximum memory.
name
+name
Memory pool name.
+Memory pool name.
used(M)
+used(M)
Size of the used memory.
+Size of the used memory.
CPU
+CPU
CPU Usage
+CPU Usage
CPU usage of the Java process.
+CPU usage of the Java process.
Viewing GC Information
APM monitors GC metrics. For details about the metrics, see Table 2.
-Figure 5 Viewing GC information-
Table 3 GC metrics Metric Set
+-Table 3 GC metrics Metric Set
Metric
+Metric
Description
+Description
GC statistics
+GC statistics
Full GC (times)
+Full GC (times)
Number of full GC times in a collection period.
+Number of full GC times in a collection period.
Full GC Duration (ms)
+Full GC Duration (ms)
Full GC duration in a collection period.
+Full GC duration in a collection period.
Young GC (times)
+Young GC (times)
Number of young GC times in a collection period.
+Number of young GC times in a collection period.
Young GC Duration (ms)
+Young GC Duration (ms)
Young GC duration in a collection period.
+Young GC duration in a collection period.
GC Details
+GC Details
GC Type
+GC Type
GC type, which can be major or minor.
+GC type, which can be major or minor.
GC Cause
+GC Cause
GC cause.
+GC cause.
Count
+Count
Number of times that GC has occurred.
+Number of times that GC has occurred.
Total GC Duration (ms)
+Total GC Duration (ms)
GC duration.
+GC duration.
Max GC Duration (ms)
+Max GC Duration (ms)
Time consumed by the slowest GC.
+Time consumed by the slowest GC.
GC Recycler
+GC Recycler
GC recycler name.
+GC recycler name.
Slowest GC Details
+Slowest GC Details
Details about the slowest GC.
+Details about the slowest GC.
- Click the digits in blue (such as those in the Count, Total GC Duration (ms), or Max GC Duration (ms) column) to view the corresponding GC trend graph in a certain period (default: 20 minutes).
- On the GC details area, you can view the GC type, GC cause, count, total GC duration (ms), maximum GC duration (ms), GC recycler, and slowest GC details (details and history).
- Click the numbers in pink (such as those in the Count, Total GC Duration (ms), or Max GC Duration (ms) column) to view the corresponding GC trend graph in a certain period (default: 20 minutes).
- On the GC details area, you can view the GC type, GC cause, count, total GC duration (ms), maximum GC duration (ms), GC recycler, and slowest GC details (details and history).
Viewing Threads
You can view the thread details of the corresponding instance on APM. For details, see Table 4.
-Figure 6 Viewing threads-
Table 4 Thread metrics Metric Set
+Table 4 Thread metrics Metric Set
Metric
+Metric
Description
+Description
Thread details
+Thread details
Thread Name
+Thread Name
Thread name.
+Thread name.
Threads
+Threads
Number of threads.
+Number of threads.
CPU Time (ms)
+CPU Time (ms)
Thread CPU time.
+Thread CPU time.
Memory (MB)
+Memory (MB)
Memory (MB).
+Memory (MB).
Thread Stack
+Thread Stack
Thread stack.
+Thread stack.
- Click a number in the Threads column to view the trend of the thread in a specified period.
- Click Detail in the Thread Stack column to view the thread details.
- Click History in the Thread Stack column to view the historical thread stack list.
Viewing Java Methods
- By default, APM does not monitor Java methods. To monitor them, configure the JavaMethod monitoring item first.
- After the configuration is complete, the system monitors the methods and classes of JavaMethod.
- On the JVM page, select a target instance and JavaMethod to view details. For details, see Table 5.
Figure 7 Viewing Java methods-
Table 5 JavaMethod metrics Metric Set
+Table 5 JavaMethod metrics Metric Set
Metric
+Metric
Description
+Description
JavaMethod
+JavaMethod
Class
+Class
Class of a Java method.
+Class of a Java method.
Method
+Method
Method.
+Method.
Calls
+Calls
Number of times that the method is called.
+Number of times that the method is called.
Avg RT (ms)
+Avg RT (ms)
Average response time.
+Average response time.
Errors
+Errors
Number of times that the method fails to be called.
+Number of times that the method fails to be called.
Max Concurrency
+Max Concurrency
Maximum concurrency of the method.
+Maximum concurrency of the method.
Max RT (ms)
+Max RT (ms)
Maximum response time of the method.
+Maximum response time of the method.
0 ms–10 ms
+0 ms–10 ms
Number of requests with 0 ms–10 ms response time.
+Number of requests with 0 ms–10 ms response time.
10 ms–100 ms
+10 ms–100 ms
Number of requests with 10 ms–100 ms response time.
+Number of requests with 10 ms–100 ms response time.
100 ms–500 ms
+100 ms–500 ms
Number of requests with 100 ms–500 ms response time.
+Number of requests with 100 ms–500 ms response time.
500 ms–1s
+500 ms–1s
Number of requests with 500 ms–1s response time.
+Number of requests with 500 ms–1s response time.
1s–10s
+1s–10s
Number of requests with 1s–10s response time.
+Number of requests with 1s–10s response time.
10s–n
+10s–n
Number of requests with response time longer than 10s.
+Number of requests with response time longer than 10s.
Exception
This function monitors application exception logs. Take the monitoring of Java exception logs as an example. Once you use the log system to print logs, they will be collected by APM. The exception collection type varies according to the collector type.
-Viewing Exception Logs
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. - Click the Exception tab. By default, exception logs of all instances are displayed. For details about the metrics, see Table 1.Figure 1 Exception monitoring data- -
Table 1 Exception and log parameters Metric Set
+Viewing Exception Logs
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. - Click the Exception tab. By default, exception logs of all instances are displayed. For details about the metrics, see Table 1.
+
-Table 1 Exception and log parameters Metric Set
Parameter
+Parameter
Description
+Description
Exception
+Exception
Class
+Class
Exception class
+Exception class
Exception Type
+Exception Type
Exception type
+Exception type
Log Type
+Log Type
Exception log type
+Exception log type
Total Exceptions
+Total Exceptions
Number of times that an exception has occurred
+Number of times that an exception has occurred
Message
+Message
Message returned when the exception occurred
+Message returned when the exception occurred
Error Stack
+Error Stack
Error stack
+Error stack
Log Version
+Log Version
Log Type
+Log Type
Log type
+Log type
Version
+Version
Version
+Version
- Click a number in blue in the Total Exceptions column to view the trend of the total exceptions in a specified period.
- Click the blue text in the Message column to view the message time and content.
- Click Detail in the Error Stack column to view exception details.
- Click History in the Error Stack column to view the historical error stack list.
-- Click a number in pink in the Total Exceptions column to view the trend of the total exceptions in a specified period.
- Click the pink text in the Message column to view the message time and content.
- Click Detail in the Error Stack column to view exception details.
- Click History in the Error Stack column to view the historical error stack list.
- Click the blue text in the Version column to view details.
- On the Exception tab page, select a target instance and then select Exception to view the exception monitoring data.
Figure 2 Selecting a target instance and exception-
- Select a time range. Default: Last 20 minutes.
Options: Last 20 minutes, Last hour, Last 3 hours, Last 6 hours, Last day, Today, Yesterday, Last week, Last month, or Custom.
-- Click
+
in the upper right corner of the list and select the metric data you want to view.- Click the pink text in the Version column to view details.
- On the Exception tab page, select a target instance and then select Exception to view the exception monitoring data.
- Select a time range. Default: Last 20 minutes.
Options: Last 20 minutes, Last hour, Last 3 hours, Last 6 hours, Last day, Today, Yesterday, Last week, Last month, or Custom.
+- Click
in the upper right corner of the list and select the metric data you want to view.
@@ -73,10 +71,3 @@- - \ No newline at end of file diff --git a/docs/apm/umn/apm_07_0009.html b/docs/apm/umn/apm_07_0009.html index 44326bffb..f071c9441 100644 --- a/docs/apm/umn/apm_07_0009.html +++ b/docs/apm/umn/apm_07_0009.html @@ -3,210 +3,205 @@Call
This function monitors the calls of external services by the current application. It covers CSEConsumer, ApacheHttpClient, ApacheHttpAsyncClient, DubboConsumer, and HttpClient monitoring.
This section focuses on HttpClient monitoring.
-Going to the Call Page
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. - Click the Call tab. By default, the HttpClient monitoring information of all instances is displayed.
-Figure 1 External call data-
- On the displayed Call tab page, select a target instance and monitoring item to view the monitoring data in different metric sets.Figure 2 Selecting an instance and monitoring item-
- Select a time range. Default: Last 20 minutes.
Options: Last 20 minutes, Last hour, Last 3 hours, Last 6 hours, Last day, Today, Yesterday, Last week, Last month, or Custom.
- - Click
in the upper right corner of the list and select the metric data you want to view.
Going to the Call Page
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. - Click the Call tab. By default, the HttpClient monitoring information of all instances is displayed. +
- On the displayed Call tab page, select a target instance and monitoring item to view the monitoring data in different metric sets.
- Select a time range. Default: Last 20 minutes.
Options: Last 20 minutes, Last hour, Last 3 hours, Last 6 hours, Last day, Today, Yesterday, Last week, Last month, or Custom.
+ - Click
in the upper right corner of the list and select the metric data you want to view.
Viewing HttpClient Monitoring Data
URL summary
-The HttpClient monitoring system collects the metrics of each URL. For details about the metrics, see Table 1. Click
-
in the upper right corner of the list and select the metric data you want to view.Figure 3 URL summary under HttpClient monitoring+
The HttpClient monitoring system collects the metrics of each URL. For details about the metrics, see Table 1. Click
-
in the upper right corner of the list and select the metric data you want to view.Table 1 Parameters of URL summary under HttpClient monitoring Metric Set
+-Table 1 Parameters of URL summary under HttpClient monitoring Metric Set
Metric
+Metric
Description
+Description
URL summary
+URL summary
url
+url
Called URL.
+Called URL.
method
+method
HTTP method of the URL.
+HTTP method of the URL.
Calls
+Calls
Number of times that the URL is called.
+Number of times that the URL is called.
Avg RT (ms)
+Avg RT (ms)
Average response time of the called URL.
+Average response time of the called URL.
Errors
+Errors
Number of call errors of the URL.
+Number of call errors of the URL.
Max Concurrency
+Max Concurrency
Maximum concurrency of the URL.
+Maximum concurrency of the URL.
Max RT (ms)
+Max RT (ms)
Maximum response time of the called URL.
+Maximum response time of the called URL.
0 ms–10 ms
+0 ms–10 ms
Number of requests with 0 ms–10 ms response time.
+Number of requests with 0 ms–10 ms response time.
10 ms–100 ms
+10 ms–100 ms
Number of requests with 10 ms–100 ms response time.
+Number of requests with 10 ms–100 ms response time.
100 ms–500 ms
+100 ms–500 ms
Number of requests with 100 ms–500 ms response time.
+Number of requests with 100 ms–500 ms response time.
500 ms–1s
+500 ms–1s
Number of requests with 500 ms–1s response time.
+Number of requests with 500 ms–1s response time.
1s–10s
+1s–10s
Number of requests with 1s–10s response time.
+Number of requests with 1s–10s response time.
10s–n
+10s–n
Number of requests with response time longer than 10s.
+Number of requests with response time longer than 10s.
Error Trace
+Error Trace
ID of the trace that encounters an error in a collection period.
+ID of the trace that encounters an error in a collection period.
Slowest Trace
+Slowest Trace
ID of the slowest trace in a collection period.
+ID of the slowest trace in a collection period.
- Click a number in blue (such as those in the Calls or Avg RT (ms) column) to view more details.
- Click the text in blue (such as those in the Slowest Trace or Error Trace column) to view more details.
- Click a number in pink (such as those in the Calls or Avg RT (ms) column) to view more details.
- Click the text in pink (such as those in the Slowest Trace or Error Trace column) to view more details.
Cluster summary
APM can summarize external call metrics by cluster. For details about the metrics, see Table 2.
-Figure 4 Cluster summary under HttpClient monitoring-
Table 2 Parameters of cluster summary under HttpClient monitoring Metric Set
+-Table 2 Parameters of cluster summary under HttpClient monitoring Metric Set
Metric
+Metric
Description
+Description
Cluster summary
+Cluster summary
envId
+envId
Cluster ID of the called party.
+Cluster ID of the called party.
hostUri
+hostUri
URL of the called party.
+URL of the called party.
Calls
+Calls
Number of times that the cluster URL is called.
+Number of times that the cluster URL is called.
Avg RT (ms)
+Avg RT (ms)
Average response time for calling the cluster URL.
+Average response time for calling the cluster URL.
Errors
+Errors
Number of call errors of the URL.
+Number of call errors of the URL.
Max RT (ms)
+Max RT (ms)
Maximum response time for calling the cluster URL.
+Maximum response time for calling the cluster URL.
0 ms–10 ms
+0 ms–10 ms
Number of requests with 0 ms–10 ms response time.
+Number of requests with 0 ms–10 ms response time.
10 ms–100 ms
+10 ms–100 ms
Number of requests with 10 ms–100 ms response time.
+Number of requests with 10 ms–100 ms response time.
100 ms–500 ms
+100 ms–500 ms
Number of requests with 100 ms–500 ms response time.
+Number of requests with 100 ms–500 ms response time.
500 ms–1s
+500 ms–1s
Number of requests with 500 ms–1s response time.
+Number of requests with 500 ms–1s response time.
1s–10s
+1s–10s
Number of requests with 1s–10s response time.
+Number of requests with 1s–10s response time.
10s–n
+10s–n
Number of requests with response time longer than 10s.
+Number of requests with response time longer than 10s.
- Click a number in blue (such as those in the Calls or Avg RT (ms) column) to view more details.
- Click a number in pink (such as those in the Calls or Avg RT (ms) column) to view more details.
Status code summary
APM can summarize external call metrics by status code. For details about the metrics, see Table 3.
-Figure 5 Status code summary under HttpClient monitoring-
Table 3 Parameters of status code summary under HttpClient monitoring Metric Set
+Table 3 Parameters of status code summary under HttpClient monitoring Metric Set
Metric
+Metric
Description
+Description
Status code summary
+Status code summary
code
+code
Status code.
+Status code.
Count
+Count
Number of times that the status code occurred.
+Number of times that the status code occurred.
Latest URL
+Latest URL
URL that returns the status code.
+URL that returns the status code.
- Click a status code in the code column. The tracing page is displayed, showing the invocation condition of the status code of the selected instance in the environment in last 20 minutes (default).
- Click a number in the Count column to view the trend of the status code in a specified period.
- Click the latest URL to view the invocation details of the corresponding status code.
Exception
On the Exception tab page, view the exception statistics about HttpClient calls. For details about the metrics, see Table 4.
-Figure 6 HttpClient monitoring exceptions-
Table 4 Parameters of HttpClient monitoring exceptions Metric Set
+-Table 4 Parameters of HttpClient monitoring exceptions Metric Set
Metric
+Metric
Description
+Description
Exception
+Exception
causeType
+causeType
Exception class.
+Exception class.
exceptionType
+exceptionType
Exception type.
+Exception type.
Count
+Count
Number of times the exception occurred.
+Number of times the exception occurred.
Error Message
+Error Message
Message returned when the exception occurred.
+Message returned when the exception occurred.
Error Stack
+Error Stack
Exception stack information.
+Exception stack information.
- Click a number in blue in the Count column to view the trend of the thread in a specified period.
- Click the text in blue in the Error Message column to view message details.
- Click Detail in the Error Stack column to view exception details.
- Click History in the Error Stack column to view the historical error stack list.
- Click a number in pink in the Count column to view the trend of the thread in a specified period.
- Click the text in pink in the Error Message column to view message details.
- Click Detail in the Error Stack column to view exception details.
- Click History in the Error Stack column to view the historical error stack list.
Overview
On the Overview tab page, view the metrics of the selected instance. For details about the metrics, see Table 5.
-Figure 7 Overview under HttpClient monitoring-
Table 5 Overview parameters of HttpClient monitoring Metric Set
+Table 5 Overview parameters of HttpClient monitoring Metric Set
Metric
+Metric
Description
+Description
Overview
+Overview
Calls
+Calls
Total number of calls.
+Total number of calls.
Avg RT (ms)
+Avg RT (ms)
Average response time
+Average response time
Errors
+Errors
Total number of errors.
+Total number of errors.
SQL
This function monitors database access. The databases that can be monitored include the C3P0, Cassandra, ClickHouse, DBCP, Druid, EsRestClient, GaussDB, Hikari, Jetcd, ObsClient, MySQL, PostgreSQL, Oracle, HBase, and MongoDB. APM collects details about executed statements to help you locate performance problems in code.
This section focuses on MySQL database monitoring.
-Going to the SQL Page
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. - Click the SQL tab. By default, the MySQL database information of all instances is displayed.Figure 1 Going to the SQL page-
- On the displayed SQL tab page, select a target instance and monitoring item to view the monitoring data in different metric sets.Figure 2 Selecting an instance and monitoring item-
- Select a time range. Default: Last 20 minutes.
Options: Last 20 minutes, Last hour, Last 3 hours, Last 6 hours, Last day, Today, Yesterday, Last week, Last month, or Custom.
-Figure 3 Selecting a time range-
- Click
in the upper right corner of the list and select the metric data you want to view.
Going to the SQL Page
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. - Click the SQL tab. By default, the MySQL database information of all instances is displayed.
- On the displayed SQL tab page, select a target instance and monitoring item to view the monitoring data in different metric sets.
- Select a time range. Default: Last 20 minutes.
Options: Last 20 minutes, Last hour, Last 3 hours, Last 6 hours, Last day, Today, Yesterday, Last week, Last month, or Custom.
+Figure 1 Selecting a time range+ - Click
in the upper right corner of the list and select the metric data you want to view.
Viewing MySQL Database Monitoring Data
SQL summary
APM can monitor MySQL databases by SQL. For details about the metrics, see Table 1. Click
-
in the upper right corner of the list and select the metric data you want to view.Figure 4 SQL summary under MySQL database monitoring-
Table 1 SQL summary parameters Metric Set
+-Table 1 SQL summary parameters Metric Set
Metric
+Metric
Description
+Description
SQL monitoring
+SQL monitoring
sql
+sql
Unique ID of the SQL statement, which is used for alarm configuration.
+Unique ID of the SQL statement, which is used for alarm configuration.
SQL Statement
+SQL Statement
SQL statement.
+SQL statement.
Calls
+Calls
Number of times that the SQL statement is called.
+Number of times that the SQL statement is called.
Avg RT (ms)
+Avg RT (ms)
Average response time (ms).
+Average response time (ms).
Errors
+Errors
Number of errors that the SQL statement encounters.
+Number of errors that the SQL statement encounters.
Rows Read
+Rows Read
Number of read rows of the SQL statement.
+Number of read rows of the SQL statement.
Rows Updated
+Rows Updated
Number of updated rows of the SQL statement.
+Number of updated rows of the SQL statement.
Max Concurrency
+Max Concurrency
Maximum concurrency of the SQL statement.
+Maximum concurrency of the SQL statement.
Max RT (ms)
+Max RT (ms)
Maximum response time of the SQL statement.
+Maximum response time of the SQL statement.
0 ms–10 ms
+0 ms–10 ms
Number of requests with 0 ms–10 ms response time.
+Number of requests with 0 ms–10 ms response time.
10 ms–100 ms
+10 ms–100 ms
Number of requests with 10 ms–100 ms response time.
+Number of requests with 10 ms–100 ms response time.
100 ms–200 ms
+100 ms–200 ms
Number of requests with 100 ms–200 ms response time.
+Number of requests with 100 ms–200 ms response time.
200 ms–1s
+200 ms–1s
Number of requests with 200 ms–1s response time.
+Number of requests with 200 ms–1s response time.
1s–10s
+1s–10s
Number of requests with 1s–10s response time.
+Number of requests with 1s–10s response time.
10s–n
+10s–n
Number of requests with response time longer than 10s.
+Number of requests with response time longer than 10s.
Slowest Trace
+Slowest Trace
ID of the slowest trace in a collection period.
+ID of the slowest trace in a collection period.
Error Trace
+Error Trace
ID of the trace that encounters an error in a collection period.
+ID of the trace that encounters an error in a collection period.
- Click an SQL statement to view details.
- Click a number in blue (such as those in the Calls or Avg RT (ms) column) to view more details.
- Click a slow or an error trace to view its details.
- Click an SQL statement to view details.
- Click a number in pink (such as those in the Calls or Avg RT (ms) column) to view more details.
- Click a slow or an error trace to view its details.
Database summary
APM can summarize MySQL database metrics by database. For details about the metrics, see Table 2.
-Figure 5 Database summary under MySQL database monitoring-
Table 2 Database summary parameters Metric Set
+-Table 2 Database summary parameters Metric Set
Metric
+Metric
Description
+Description
Database connections
+Database connections
db
+db
Database name.
+Database name.
Connections Created
+Connections Created
Number of connections created by the database.
+Number of connections created by the database.
Connections Destroyed
+Connections Destroyed
Number of the database's connections that have been destroyed.
+Number of the database's connections that have been destroyed.
Avg RT (ms)
+Avg RT (ms)
Average response time (ms).
+Average response time (ms).
Calls
+Calls
Number of times that the database is called.
+Number of times that the database is called.
Errors
+Errors
Number of errors that the database encounters.
+Number of errors that the database encounters.
Rows Read
+Rows Read
Number of rows read from the database.
+Number of rows read from the database.
Rows Updated
+Rows Updated
Number of rows updated in the database.
+Number of rows updated in the database.
Max RT (ms)
+Max RT (ms)
Maximum response time of the database.
+Maximum response time of the database.
0 ms–10 ms
+0 ms–10 ms
Number of requests with 0 ms–10 ms response time.
+Number of requests with 0 ms–10 ms response time.
10 ms–100 ms
+10 ms–100 ms
Number of requests with 10 ms–100 ms response time.
+Number of requests with 10 ms–100 ms response time.
100 ms–200 ms
+100 ms–200 ms
Number of requests with 100 ms–200 ms response time.
+Number of requests with 100 ms–200 ms response time.
200 ms–1s
+200 ms–1s
Number of requests with 200 ms–1s response time.
+Number of requests with 200 ms–1s response time.
1s–10s
+1s–10s
Number of requests with 1s–10s response time.
+Number of requests with 1s–10s response time.
10s–n
+10s–n
Number of requests with response time longer than 10s.
+Number of requests with response time longer than 10s.
Click a number in blue (such as those in the Calls or Avg RT (ms) column) to view more details.
+Click a number in pink (such as those in the Calls or Avg RT (ms) column) to view more details.
Exception
On the Exception tab page, view exception statistics about SQL calls. For details about the metrics, see Table 3.
-Figure 6 Viewing exception statistics about SQL calls-
Table 3 Exception parameters Metric Set
+Table 3 Exception parameters Metric Set
Metric
+Metric
Description
+Description
Exception
+Exception
causeType
+causeType
Exception class.
+Exception class.
exceptionType
+exceptionType
Exception type.
+Exception type.
Count
+Count
Number of exceptions.
+Number of exceptions.
SQL
+SQL
SQL statement that encounters an exception.
+SQL statement that encounters an exception.
Error Stack
+Error Stack
Exception stack information.
+Exception stack information.
Message
+Message
Error message.
+Error message.
Overview
On the Overview tab page, view the call trend of the selected instance. For details about the metrics, see Table 4.
-Figure 7 Overview-
-Table 4 Overview parameters Metric Set
+Table 4 Overview parameters Metric Set
Metric
+Metric
Description
+Description
Overview
+Overview
Calls
+Calls
Total number of calls.
+Total number of calls.
Rows Read
+Rows Read
Total number of read rows.
+Total number of read rows.
Avg RT (ms)
+Avg RT (ms)
Average response time (ms).
+Average response time (ms).
Errors
+Errors
Total number of errors.
+Total number of errors.
Rows Updated
+Rows Updated
Number of rows updated in the database.
+Number of rows updated in the database.
Info
-On the Info tab page, view the driver version information. Click the text in blue to view more details.
-Figure 8 Info+
On the Info tab page, view the driver version information. Click the text in pink to view more details.
Viewing Druid Connection Pool Monitoring Data
The Druid connection pool monitoring system collects data sources, connection details, additional configurations, and exception information. You can click
@@ -537,10 +530,9 @@
in the upper right corner of the list to customize the columns you want to view. For details about the metrics, see Table 5.- Click a number in blue (such as those in the Calls or Avg RT (ms) column) to view more details.
- Click the text in blue (such as those in the Driver or Driver Version column) to view more details.
Figure 9 Viewing Druid connection pool monitoring data+
- Click a number in pink (such as those in the Calls or Avg RT (ms) column) to view more details.
- Click the text in pink (such as those in the Driver or Driver Version column) to view more details.
Viewing Hikari Connection Pool Monitoring Data
The Hikari connection pool monitoring system collects the pool details, connection details, and exception information. You can click
+
in the upper right corner of the list to customize the columns you want to view. For details about the metrics, see Table 6.Viewing Hikari Connection Pool Monitoring Data
The Hikari connection pool monitoring system collects the pool details, connection details, and exception information. You can click
-
in the upper right corner of the list to customize the columns you want to view. For details about the metrics, see Table 6.- Click a number in blue (such as those in the Calls or Avg RT (ms) column) to view more details.
- Click a number in pink (such as those in the Calls or Avg RT (ms) column) to view more details.
diff --git a/docs/apm/umn/apm_07_0012.html b/docs/apm/umn/apm_07_0012.html index 9a24eb5bf..6279acf43 100644 --- a/docs/apm/umn/apm_07_0012.html +++ b/docs/apm/umn/apm_07_0012.html @@ -2,13 +2,13 @@Configuration Details
You can define collection parameters for some collectors corresponding to monitoring items.
-- On the Monitoring Item tab page, only monitoring items related to the connected application are displayed.
-Configuring a Monitoring Item
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. The instance monitoring page is displayed. - Click the Monitoring Item tab.
- Locate the row that contains the target monitoring item and click Modify in the Operation column.Figure 1 Configuring a monitoring item+
+Constraints
On the Monitoring Item tab page, only monitoring items related to the connected application are displayed.
+-Configuring a Monitoring Item
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. The instance monitoring page is displayed. - Click the Monitoring Item tab.
- Locate the row that contains the target monitoring item and click Modify in the Operation column.Figure 1 Configuring a monitoring item
- On the displayed page, edit the monitoring configuration. For details, see the corresponding section.Figure 2 Editing the JVM monitoring configuration
- Click Yes.
diff --git a/docs/apm/umn/apm_07_0013.html b/docs/apm/umn/apm_07_0013.html index c346cc21c..a26141bff 100644 --- a/docs/apm/umn/apm_07_0013.html +++ b/docs/apm/umn/apm_07_0013.html @@ -1,7 +1,7 @@Enabling or Disabling a Monitoring Item
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. The instance monitoring page is displayed. - Click the Monitoring Item tab.Figure 3 Enabling or disabling a monitoring item+
Enabling or Disabling a Monitoring Item
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click next to the target environment. The instance monitoring page is displayed.
- Click the Monitoring Item tab.Figure 3 Enabling or disabling a monitoring item
- Locate the row that contains the target monitoring item and enable or disable it.
Configuring the MySQL Monitoring Item
-On the Modify MySQL Monitoring Configuration page, set the following parameters:- Collection Interval: The default value is 60s and cannot be changed.
- Collect Original SQL: This function is disabled by default. In that case, only SQL statements without values are collected, for example, select name from user where id=?. When this function is enabled, SQL statements with values are collected, for example, select name from user where id=1.
- shardTableName: specified when you need to aggregate multiple tables into one table. For example, there are two tables: UserTable_1 and UserTable_2. By default, two SQL statements (select name from UserTable_1 and select name from UserTable_2) are displayed on the SQL monitoring page. If you set shardTableName to UserTable, tables starting with UserTable are aggregated into the same table. Only one SQL statement (select name from UserTable) is displayed on the SQL monitoring page.
diff --git a/docs/apm/umn/apm_07_0015.html b/docs/apm/umn/apm_07_0015.html index 0986d81ed..915b337f7 100644 --- a/docs/apm/umn/apm_07_0015.html +++ b/docs/apm/umn/apm_07_0015.html @@ -1,104 +1,105 @@On the Modify MySQL Monitoring Configuration page, set the following parameters:- Collection Interval: The default value is 60s and cannot be changed.
- Collect Original SQL: This function is disabled by default. In that case, only SQL statements without values are collected, for example, select name from user where id=?. When this function is enabled, SQL statements with values are collected, for example, select name from user where id=1.
- shardTableName: specified when you need to aggregate multiple tables into one table. For example, there are two tables: UserTable_1 and UserTable_2. By default, two SQL statements (select name from UserTable_1 and select name from UserTable_2) are displayed on the SQL monitoring page. If you set shardTableName to UserTable, tables starting with UserTable are aggregated into the same table. Only one SQL statement (select name from UserTable) is displayed on the SQL monitoring page.
- mysqlMaxRows: the maximum number of MySQL rows that can be collected by the Agent. If this value has been reached, the Agent stops collecting data immediately. The default value is 500. The value ranges from 10 to 2000.
- sqlSize: the maximum number of SQL statement bytes that can be collected by the Agent. Only when the number of bytes is within sqlSize, can SQL statements be collected. The default value is 2000. The value ranges from 10 to 4096.
Figure 1 Configuring the MySQL monitoring item
Configuring the URL Monitoring Item
-On the Modify URL Monitoring Configuration page, set the following parameters:- -
For security purposes, do not contain sensitive data in headers, URL parameters, cookies, or other parameters.
-Parameter
+On the Modify URL Monitoring Configuration page, set the following parameters:
+Constraints
For security purposes, do not contain sensitive data in headers, URL parameters, cookies, or other parameters. ++Parameter
Description
+Description
Example
+Example
Collection Interval
+Collection Interval
The default value is 60s and cannot be changed.
+The default value is 60s and cannot be changed.
60s
+60s
Key for Header Value Interception
+Key for Header Value Interception
Key specified for collecting values in headers. The collected information can be seen in the trace parameters.
+Key specified for collecting values in headers. The collected information can be seen in the trace parameters.
Host
+Host
Key for Parameter Value Interception
+Key for Parameter Value Interception
Key specified for collecting values in URLs. The collected information can be seen in the trace parameters. Take http://127.0.0.1/test?param=123 as an example. If the key is set to param, value 123 can be seen in the trace parameters.
+Key specified for collecting values in URLs. The collected information can be seen in the trace parameters. Take http://127.0.0.1/test?param=123 as an example. If the key is set to param, value 123 can be seen in the trace parameters.
param
+param
Key for Cookie Value Interception
+Key for Cookie Value Interception
Key specified for collecting values in cookies. The collected information can be seen in the trace parameters.
+Key specified for collecting values in cookies. The collected information can be seen in the trace parameters.
testKey
+testKey
URL Collection Configuration
+URL Collection Configuration
URLs that meet the conditions you set are aggregated. For example, /rest/v1/test/123 and /rest/v1/test/234 can be aggregated into /rest/v1/test/{id}. The configuration method is the same as that described in HttpClient URL Normalization.
+URLs that meet the conditions you set are aggregated. For example, /rest/v1/test/123 and /rest/v1/test/234 can be aggregated into /rest/v1/test/{id}. The configuration method is the same as that described in HttpClient URL Normalization.
+Generated By: user or automatic. If Generated By is set to automatic, the normalization mode can only be regex.
+Status: active or inactive. If Status is set to inactive, the current URL collection configuration does not take effect.
+ Blocklist Configuration
+Blocklist Configuration
Data of URLs that meet the conditions you set will not be collected. The configuration method is the same as that described in HttpClient URL Normalization.
+Data of URLs that meet the conditions you set will not be collected. The configuration method is the same as that described in HttpClient URL Normalization.
+ Service Code Length
+Service Code Length
Maximum length of the response body to be parsed to prevent the performance from being affected. Content that beyond this limit will not be parsed, but corresponding service status codes are regarded as normal by default.
+Maximum length of the response body to be parsed to prevent the performance from being affected. Content that beyond this limit will not be parsed, but corresponding service status codes are regarded as normal by default.
-
+-
Key for Service Code Interception
+Key for Service Code Interception
Key specified for collecting service status codes. If the custom API returned content is {"errorCode":500,"errorMsg":"error msg"}, set this parameter to errorCode.
+Key specified for collecting service status codes. If the custom API returned content is {"errorCode":500,"errorMsg":"error msg"}, set this parameter to errorCode.
errorCode
+errorCode
Normal Service Code
+Normal Service Code
If this status code is returned, traces are regarded as normal. If other codes are returned, traces are regarded as abnormal.
+If this status code is returned, traces are regarded as normal. If other codes are returned, traces are regarded as abnormal.
-
+-
Slow Request Threshold
+Slow Request Threshold
Global response time threshold. The default value is 800. Requests with the response time longer than 800 ms are regarded as slow requests. The sampling ratio of slow requests will be increased.
+Global response time threshold. The default value is 800. Requests with the response time longer than 800 ms are regarded as slow requests. The sampling ratio of slow requests will be increased.
-
+-
URL Configuration
+URL Configuration
Response time threshold separately set for a URL. If the response time of this URL exceeds the threshold, the sampling rate of this URL will be increased. If this parameter is not set, the global slow request threshold is used by default.
+Response time threshold separately set for a URL. If the response time of this URL exceeds the threshold, the sampling rate of this URL will be increased. If this parameter is not set, the global slow request threshold is used by default.
+ Error Code
+Error Code
Options: 400 or greater and 500 or greater (default). By default, if status code 500 or greater occurs, the system regards that there is an error.
+Options: 400 or greater and 500 or greater (default). By default, if status code 500 or greater occurs, the system regards that there is an error.
-
+-
URL Automatic Normalization
+URL Automatic Normalization
Example: There are three URL invocations:
+Example: There are three URL invocations:
/get/xxx/a
/get/xxx/b
/get/xxx/b
@@ -108,13 +109,14 @@- If this parameter is set to No, URL automatic normalization is disabled.
/get/xxx/{p} 3
- Use default value: The inherited tag value is preferentially used.
-
+-
diff --git a/docs/apm/umn/apm_07_0017.html b/docs/apm/umn/apm_07_0017.html index 09cd5252a..28c32396a 100644 --- a/docs/apm/umn/apm_07_0017.html +++ b/docs/apm/umn/apm_07_0017.html @@ -1,10 +1,8 @@Monitoring Item Views
-APM supports summary tables, trend graphs, latest data tables, and original data tables.- Summary table: records the summary calculation results based on the primary key metric within a period. You can click a number or character string in the summary table to view the trend graph of the primary key metric.
- Trend graph: displays the trend of a primary key metric in a period. A trend graph may have breakpoints, indicating that no data is collected in this period. There are multiple reasons why data is not collected. For example, collectors do not collect the metrics with zero calls or the data may be lost.
- Original data table: For character strings, no trend graphs can be generated. Therefore, original data tables are used. Each row indicates the mapping between a time and a value.
- Latest data table: displays the latest data. You can click a data record to view its trend graph.
APM supports summary tables, trend graphs, latest data tables, and original data tables. The view of each monitoring item is configured in the background and has not been opened. You can check views together with corresponding background metric sets. For details, see Metric Sets.-- Summary table: records the summary calculation results based on the primary key metric within a period. You can click a number or character string in the summary table to view the trend graph of the primary key metric.
- Trend graph: displays the trend of a primary key metric in a period. A trend graph may have breakpoints, indicating that no data is collected in this period. There are multiple reasons why data is not collected. For example, collectors do not collect the metrics with zero calls or the data may be lost.
- Original data table: For character strings, no trend graphs can be generated. Therefore, original data tables are used. Each row indicates the mapping between a time and a value.
- Latest data table: displays the latest data. You can click a data record to view its trend graph.
The view of each monitoring item is configured in the background and has not been opened. You can check views together with corresponding background metric sets. For details, see Metric Sets.
-diff --git a/docs/apm/umn/apm_07_0018.html b/docs/apm/umn/apm_07_0018.html index 8e6facc2c..ab0858b61 100644 --- a/docs/apm/umn/apm_07_0018.html +++ b/docs/apm/umn/apm_07_0018.html @@ -8,119 +8,119 @@The advantage of the preceding algorithm is that once the trace information is generated, the link is complete, helping you make correct decisions. If a large number of URLs are called, abnormal requests may fail to be collected. In this case, you can collect metrics to locate system exceptions.
Trace Search
This function is used to search for span information, that is, the root event of a node. A trace can be found in multiple environments. For example, in the scenario where service A calls service B and then calls service C, the same trace may be found from services A, B, and C.
-- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Tracing.
- Specify the following search criteria or add custom criteria to query traces.
-
Table 1 Search criteria of traces Search Criterion
+- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Tracing.
- Select a time range in the upper right corner of the page. Default: Last 20 minutes. Options: Last 20 minutes, Last hour, Last 3 hours, Last 6 hours, Last day, Today, Yesterday, or Custom.
- Specify the following search criteria or add custom criteria to query traces.
+
Table 1 Search criteria of traces Search Criterion
Description
+Description
Mandatory
+Mandatory
Application
+Application
Application to which the trace belongs.
+Application to which the trace belongs.
Yes
+Yes
Region
+Region
Region where the trace is located.
+Region where the trace is located.
Yes
+Yes
Component
+Component
Component to which the trace belongs.
+Component to which the trace belongs.
No
+No
Environment
+Environment
Environment to which the trace belongs.
+Environment to which the trace belongs.
No
+No
Instance
+Instance
Instance to which the trace belongs.
+Instance to which the trace belongs.
No
+No
URL
+URL
Trace URL, which can be a REST URL or real URL. A REST URL contains a variable name, for example, /apm/get/{id}. A real URL indicates an actual URL.
+Trace URL, which can be a REST URL or real URL. A REST URL contains a variable name, for example, /apm/get/{id}. A real URL indicates an actual URL.
No
+No
Exact Search
+Exact Search
Whether to perform exact match on URLs. If this option is selected, exact match is performed. If this option is not selected, fuzzy match is performed.
+Whether to perform exact match on URLs. If this option is selected, exact match is performed. If this option is not selected, fuzzy match is performed.
No
+No
Call Method
+Call Method
HTTP method of the trace.
+HTTP method of the trace.
No
+No
Status Code
+Status Code
HTTP status code returned by the trace.
+HTTP status code returned by the trace.
No
+No
Response Time
+Response Time
Response time range of the trace. You can specify the minimum and maximum response time to search for the trace or leave them empty.
+Response time range of the trace. You can specify the minimum and maximum response time to search for the trace or leave them empty.
No
+No
Exception or Not
+Exception or Not
Whether to filter the traces that are regarded as exceptions.
+Whether to filter the traces that are regarded as exceptions.
No
+No
Trace ID
+Trace ID
If you specify this parameter, other search criteria become invalid and the search will be performed based on the trace ID you specify.
+If you specify this parameter, other search criteria become invalid and the search will be performed based on the trace ID you specify.
No
+No
Custom Parameter
+Custom Parameter
- Custom search is supported for otel.scope.name and thread.id only. For more, contact O&M personnel.
- Search for traces by call parameter. The format is key=value. Example: exceptionMsg=failed.
- Configure required parameters before you search for traces by custom parameter. For example, if you have configured Key for Header Value Interception, Key for Parameter Value Interception, and Key for Cookie Value Interception for URL monitoring, you can set key=value to search, for example, httpMethod=POST.
- Custom search is supported for otel.scope.name and thread.id only. For more, contact O&M personnel.
- Search for traces by call parameter. The format is key=value. Example: exceptionMsg=failed.
- Configure required parameters before you search for traces by custom parameter. For example, if you have configured Key for Header Value Interception, Key for Parameter Value Interception, and Key for Cookie Value Interception for URL monitoring, you can set key=value to search, for example, httpMethod=POST.
For details about how to configure URL monitoring, see Configuring the URL Monitoring Item.
No
+No
Global Trace ID
+Global Trace ID
Global ID of a trace. If you specify this parameter, other search criteria become invalid and the search will be performed based on the trace ID you specify.
+Global ID of a trace. If you specify this parameter, other search criteria become invalid and the search will be performed based on the trace ID you specify.
No
+No
Application Code
+Application Code
If you have configured Service Code Length, Key for Service Code Interception, and Normal Service Code, corresponding application codes will be collected. You can search information based on application codes. Generally, the value of Application Code is the same as the value of Normal Service Code. For details about how to configure URL monitoring, see Configuring the URL Monitoring Item.
+If you have configured Service Code Length, Key for Service Code Interception, and Normal Service Code, corresponding application codes will be collected. You can search information based on application codes. Generally, the value of Application Code is the same as the value of Normal Service Code. For details about how to configure URL monitoring, see Configuring the URL Monitoring Item.
No
+No
In the displayed trace list, click
next to the target trace to view its basic information, as shown in the following figure.Figure 1 Basic information about a trace
Parameter description:
-- HTTP method of the trace.
- REST URL of the trace. A REST URL contains a variable name, for example, /apm/get/{id}. You can click the URL to go to the trace details page.
- Start time of the trace.
- HTTP status code returned by the trace.
- Response time of the trace.
- Trace ID.
- Component to which the trace belongs.
- Environment to which the trace belongs.
- Host of the instance to which the trace belongs.
- IP address of the instance to which the trace belongs.
- Actual URL of the trace.
- HTTP method of the trace.
- REST URL of the trace. A REST URL contains a variable name, for example, /apm/get/{id}. You can click the URL to go to the trace details page.
- Start time of the trace.
- HTTP status code returned by the trace.
- Response time of the trace.
- Trace ID.
- Component to which the trace belongs.
- Environment to which the trace belongs.
- Host of the instance to which the trace belongs.
- IP address of the instance to which the trace belongs.
- Actual URL of the trace.
- Only the traces of successful or failed requests can be displayed. The following uses Successful Request as an example.
- Click the green button next to Successful Request, only the traces of successful requests are displayed. The red button next to Failed Request becomes dimmed.
- If you click the green button again, both the traces of successful and failed requests are displayed. The red button is no longer dimmed.
- The green and red buttons cannot be grayed at the same time.
You can also click a specific URL on the monitoring item view page, for example, the table view of the URL monitoring item. In this way, you can quickly search for required trace information based on preset search criteria.
Viewing the Complete Information About the Trace, Including Local Method Stacks and Remote Call Relationships
Click the name of a trace to view its details, as shown in the following figure.
@@ -141,7 +142,8 @@Figure 2 Call relationship
Parameter description:
-- Component and environment to which the called API belongs
- Response time (unit: ms) of the client. You can hover the mouse pointer over this digit to view more details.
- Response time (unit: ms) of the server.
- Key parameter of the method in the trace method stack. For example, for a Tomcat entry method, a real URL is displayed. For a MySQL call method, an executed SQL statement is displayed.
- Number of components that are involved.
- Call parameters. Click
to view the call parameters.
- Component and environment to which the called API belongs
- Response time (unit: ms) of the client. You can hover the mouse pointer over this digit to view more details.
- Response time (unit: ms) of the server.
- Key parameter of the method in the trace method stack. For example, for a Tomcat entry method, a real URL is displayed. For a MySQL call method, an executed SQL statement is displayed.
- Number of components that are involved.
- Call parameters. Click to view the call parameters.
- Click
to download the sequence diagram. - Traces are displayed in a tree. Depth indicates the number of layers in the tree.Figure 3 Depth+
On the tracing page, you can view the topology of a single call, as well as the overall topology between different services based on collected metric data. There are two types of application topologies:
- Single-component topology: topology of a single component under an environment. You can also view the call relationships of direct and indirect upstream and downstream components.
- Global application topology: topology of some or all components under an application.
Each line in the topology indicates the call relationship between services within a period. The statistics can be collected from the calling or called party. You can click a line to view the call trend on the right. The topology can also display the call relationships between middleware. On the topology, you can view the call relationships between services and check whether the calls between services are normal to quickly locate faults.
-diff --git a/docs/apm/umn/apm_07_0020.html b/docs/apm/umn/apm_07_0020.html index 6fe6b7c18..e96b306a8 100644 --- a/docs/apm/umn/apm_07_0020.html +++ b/docs/apm/umn/apm_07_0020.html @@ -2,25 +2,18 @@Viewing the Topology of a Component
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. - Click the Topology tab to view the call and dependency relationships of the component.
Click a line between components. The detailed data is displayed on the right.
+Viewing the Topology of a Component
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. - Click the Topology tab to view the call and dependency relationships of the component.
Click a line between components. The detailed data is displayed on the right.
Enable Display only calls between components to shield the calls of external components, or click Show All to display the calls between all components except the central node.
-Figure 1 Viewing the topology of a component+
- Right-click a component and then click Viewing a Call Chain or Viewing Indicators.
Viewing the Global Topology
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click an application. The application details page is displayed.
- Click the Global Topology tab to view the call and dependency relationships of all components under the application.
- Click a line between components. The detailed data is displayed on the right.
- Enable Display only calls between components to shield the calls of external components.
- Use tags to filter calls.
Figure 2 Viewing the global topology+
Figure 1 Viewing the global topology
URL Tracing
You can view the topology of a single call, as well as the overall topology between different services. In some scenarios, the call relationships of an important business need to be traced. This process is called URL tracing. For example, to trace the API for creating online shopping orders. In APM, URL tracing consumes a large number of resources. Therefore, an entry URL will not be added for tracing by default. However, you can set that if necessary. APM has a limit on the total number of URLs added for tracing. It focuses on tracing the downstream calls for the APIs that are added for tracing. Through URL tracing, you can monitor the call relationships between important APIs and downstream services, and then detect problems more precisely.
-Configuring URL Tracing
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click the environment that needs URL tracing. The environment details page is displayed. By default, the URL tab page is displayed.
- Move the mouse pointer to the target URL, click
, and add it for URL tracing.Figure 1 Configuring URL tracing-
-Configuring URL Tracing
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click the environment that needs URL tracing. The environment details page is displayed. By default, the URL tab page is displayed.
- Move the mouse pointer to the target URL, click
, and add it for URL tracing.
diff --git a/docs/apm/umn/apm_07_0022.html b/docs/apm/umn/apm_07_0022.html index bd004c24a..bf3dd1772 100644 --- a/docs/apm/umn/apm_07_0022.html +++ b/docs/apm/umn/apm_07_0022.html @@ -4,8 +4,8 @@Checking the URL Tracing View
- On the URL tab page:
For the URL added for tracing, click
-
next to it to view its topology.Figure 2 Viewing URL tracing details+
Checking the URL Tracing View
- On the URL tab page:
For the URL added for tracing, click
next to it to view its topology.
- On the URL Tracing Views tab page:
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click an application. The application details page is displayed.
- Click the URL Tracing Views tab to check all URL tracing views of the application.
- Filter transaction views by region and environment.
- Click View in the Operation column of the row that contains the URL you want to view.Figure 3 Checking the URL tracing view-
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click an application. The application details page is displayed.
- Click the URL Tracing Views tab to check all URL tracing views of the application.
- Filter transaction views by region and environment.
- Click View in the Operation column of the row that contains the URL you want to view.
Viewing the URL Tracing Configuration
The URL which has been added for tracing will be displayed in the URL tracing configuration list.
-- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click an application. The application details page is displayed.
- Click the URL Tracing Configuration tab to check all URL tracing configurations of the application.Figure 4 Viewing the URL tracing configuration list-
- To delete a URL tracing configuration, click Delete in the Operation column.Figure 5 Deleting a URL tracing configuration-
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click an application. The application details page is displayed.
- Click the URL Tracing Configuration tab to check all URL tracing configurations of the application.
- To delete a URL tracing configuration, click Delete in the Operation column.
Viewing Transactions
Transaction URLs are displayed in a list. By default, the system displays the invocation of all entries.
-- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click an application. The application details page is displayed.
- Click the Transactions tab to view all transactions of the application.Figure 6 Viewing transactions-
- Click View the call chain in the Operation column of the target transaction. For operations related to call chains, see Tracing.Figure 7 Viewing the call chain-
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click an application. The application details page is displayed.
- Click the Transactions tab to view all transactions of the application.
- Click View the call chain in the Operation column of the target transaction. For operations related to call chains, see Tracing.
- On the URL tab page:
Alarms are reported by services connected to APM Agents when specified conditions are met. You can learn about service exceptions in a timely manner and quickly rectify faults to prevent service loss.
-Alarm process
Figure 1 Alarm process
diff --git a/docs/apm/umn/apm_07_0024.html b/docs/apm/umn/apm_07_0024.html index d66634518..ae1f6ab25 100644 --- a/docs/apm/umn/apm_07_0024.html +++ b/docs/apm/umn/apm_07_0024.html @@ -2,10 +2,10 @@Viewing Alarms
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Alarm Center > Alarm List.
- View alarms on the Alarm List page.Figure 2 Alarm list-
- Select an application from the application drop-down list to view its alarms.
- In the search text box, set search criteria, and click
to view the alarms that meet the criteria. - Click
next to Alarm Status to filter alarms by alarm status. - When necessary, enable Scheduled Refresh. In that case, the alarm list is refreshed every 5s.
- Click
in the Operation column to view the alarm details and notification.
Viewing Alarms
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Alarm Center > Alarm List.
- View alarms on the Alarm List page.Figure 2 Alarm list+
- Select an application from the application drop-down list to view its alarms.
- In the search text box, set search criteria, and click to view the alarms that meet the criteria.
- Click next to Alarm Status to filter alarms by alarm status.
- Click
to export the alarm list on the current page. A maximum of 100 alarms can be exported. - When necessary, enable Scheduled Refresh. In that case, the alarm list is refreshed every 5s.
- Click in the Operation column to view the alarm details and notification.
Configuring an Alarm Template
APM allows you to configure alarm templates. You can create multiple alarm policies under a template and bind them to nodes.
-Procedure
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click an application. The metric details page of the application is displayed.
- Click the Alarm Templates tab.Figure 1 Adding an alarm template+
Procedure
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click an application. The metric details page of the application is displayed.
- Click the Alarm Templates tab.Figure 1 Adding an alarm template
- Click Add Template to add an alarm template as prompted.
- Enter basic information and then click Next.
Template Name: Enter up to 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
Remarks: Enter up to 512 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
- - Click Add Alarm Policy to add an alarm policy.
- Basic informationFigure 2 Basic information+
- Click Add Alarm Policy to add an alarm policy.
- Basic informationFigure 2 Basic information
-Table 1 Basic information about an alarm policy Parameter
Alarm Policy Type
Options: Single-node and Aggregate. Single-node indicates single-instance metric alarms, and Aggregate indicates aggregated metric alarms of all instances under a component.
+Options: Single-node and Aggregate. Single-node indicates single-instance metric alarms, and Aggregate indicates aggregated metric alarms of all instances under a component.
Monitoring Item
Select a target monitoring item. The information about the selected item is displayed on the right.
-
+ + +
Metric Set
Select a target metric set. The information about the selected metric set is displayed on the right.
-
+ +
- Alarm ruleFigure 3 Alarm rule+
- Alarm ruleFigure 3 Alarm rule
Table 2 Alarm rule parameters Parameter
Notification Content
Alarm details, which contain up to 500 characters.
-- If Multi-Line Matching is enabled, the alarm notification content supports both Variable and Loop. If Multi-Line Matching is disabled, only Variable can be selected.
- Alarm notification content. You can customize the content or select metrics as required.
- Alarm details, which contain up to 500 characters.
- Select required metrics. Specifically, on the right of the page, click
next to the target metric. The metric will then be displayed in the notification content.
+
- If Multi-Line Matching is enabled, the alarm notification content supports both Variable and Loop. If Multi-Line Matching is disabled, only Variable can be selected.
- Alarm notification content. You can customize the content or select metrics as required.
- Alarm details, which contain up to 500 characters.
- Select required metrics. Specifically, on the right of the page, click next to the target metric. The metric will then be displayed in the notification content.
Starting and stopping a template
Turn on or off the button (
+
) in the Operation column in the row that contains the template you want to start or stop.Turn on or off the button (
) in the Operation column in the row that contains the template you want to start or stop.Creating a Custom Alarm Policy
You can create a custom alarm policy for a single component.
-Procedure
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. The instance monitoring page is displayed. - Click the Alarm Policy tab.
- Click Add Custom Alarm Policy and set the alarm condition in the same way as that when you create an alarm template.Figure 1 Creating a custom alarm policy+
-Procedure
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. The instance monitoring page is displayed. - Click the Alarm Policy tab.
- Click Add Custom Alarm Policy and set the alarm condition in the same way as that when you create an alarm template.Figure 1 Creating a custom alarm policy
Create an Alarm Policy Based on a Template
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. The instance monitoring page is displayed. - Click the Alarm Policy tab.
- In the template list, click Copy in the Operation column in the row that contains the template you want to copy.Figure 2 Creating an alarm policy based on a template-
Create an Alarm Policy Based on a Template
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click next to the target environment. The instance monitoring page is displayed.
- Click the Alarm Policy tab.
- In the template list, click Copy in the Operation column in the row that contains the template you want to copy.
More Operations
After the alarm policy is created, perform the operations listed in Table 1 if needed.
@@ -18,7 +17,7 @@
Starting or stopping a policy
In the custom alarm policy list, start ( in the Operation column) or stop the target policy.
+In the custom alarm policy list, start (
in the Operation column) or stop the target policy.Modifying a policy
diff --git a/docs/apm/umn/apm_07_0026.html b/docs/apm/umn/apm_07_0026.html index e0d428e22..8ca85300b 100644 --- a/docs/apm/umn/apm_07_0026.html +++ b/docs/apm/umn/apm_07_0026.html @@ -3,7 +3,7 @@Alarm Notification
Alarms can be sent to specified terminals by SMS message, email, or function. In this way, you can obtain component exceptions in a timely manner and quickly rectify faults to avoid service loss. Ensure that you have the SMN permission. For details, see Simple Message Notification (SMN) User Guide.
If you do not create any notification object, no alarm notifications will be received. To view alarms, log in to the APM console and choose Alarm Center > Alarm List in the navigation pane.
-Creating a Notification Object
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click an application. The metric details page of the application is displayed.
- Click the Notifications tab.
- Click Add.Figure 1 Creating a notification object+
diff --git a/docs/apm/umn/apm_07_0028.html b/docs/apm/umn/apm_07_0028.html index 91f15be58..5faf435ab 100644 --- a/docs/apm/umn/apm_07_0028.html +++ b/docs/apm/umn/apm_07_0028.html @@ -2,7 +2,7 @@Creating a Notification Object
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click an application. The metric details page of the application is displayed.
- Click the Notifications tab.
- Click Add.Figure 1 Creating a notification object
- On the displayed page, specify Region and Topic, and determine whether to enable default notification. If it is enabled, alarm notifications will be sent based on the topic and region you specify.
- If no topic is available, create one.
- If default notification is enabled, alarms will be sent to the specified region when you create an alarm policy.
- Click Yes.
Performing Operations on Agents
Agent Management allows you to check the deployment and running statuses of the Agents that are connected to APM, and to stop, start, or delete them.
-Viewing Agents
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Agent Management.
- On the Agent management page, view the Agent list.
- In the upper left corner of the page, select a target region and application.
- Set the search criteria and click
in the search box in the upper right corner of the page to filter Agents.
Viewing Agents
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Agent Management.
- On the Agent management page, view the Agent list.
- In the upper left corner of the page, select a target region and application.
- Set the search criteria and click in the search box in the upper right corner of the page to filter Agents.
Figure 1 Viewing Agents
The following table describes the Agent statuses.
diff --git a/docs/apm/umn/apm_07_0029.html b/docs/apm/umn/apm_07_0029.html index c99dcbba1..2eaa8d254 100644 --- a/docs/apm/umn/apm_07_0029.html +++ b/docs/apm/umn/apm_07_0029.html @@ -4,7 +4,7 @@Update Agent versions according to the following procedure.
-Upgrading the Manually Installed Agents
To upgrade the manually installed Agent, download the new Agent by referring to JavaAgent Download Addresses. For details, see Manually Installing Agents for Java Applications.
Upgrading Agents of Other Types
Install new Agents. For details, see Manually Installing Agents for Java Applications.
+Upgrading Agents of Other Types
Install new Agents. For details, see section Manually Installing Agents for Java Applications.
diff --git a/docs/apm/umn/apm_07_0031.html b/docs/apm/umn/apm_07_0031.html index e387af672..39a9013c5 100644 --- a/docs/apm/umn/apm_07_0031.html +++ b/docs/apm/umn/apm_07_0031.html @@ -2,7 +2,7 @@Collection Center
Collection Center displays collectors in a centralized manner. You can view and manage various collectors, metrics, and collection parameters supported by APM.
-Viewing Collector Details
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Configuration Management > Collection Center.
All the supported collectors are displayed.
+Viewing Collector Details
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Configuration Management > Collection Center.
All the supported collectors are displayed.
- In the collector list, click View Details in the Operation column in the row that contains the target collector. The collector details page is displayed.Figure 1 Viewing collector details
- The collector details page consists of three modules: basic information, collection parameters, and metric set.
- Basic information
This module displays collector information such as collector name and type.
- Collection parameters
This module displays the custom parameter settings supported by the collector. The settings take effect after being delivered to JavaAgents and are used for custom collection.
diff --git a/docs/apm/umn/apm_07_0034.html b/docs/apm/umn/apm_07_0034.html index 633e7f561..05ab9c753 100644 --- a/docs/apm/umn/apm_07_0034.html +++ b/docs/apm/umn/apm_07_0034.html @@ -3,15 +3,14 @@Access Keys
Access Key ID (AK) and Secret Access Key (SK) are your long-term identity credentials. JavaAgents report data with an AK. An AK is used together with an SK to sign requests cryptographically, ensuring that the requests are secret, complete, and correct.
-Precautions
A user can create a maximum of two access keys with identical permissions and unlimited validity. Keep your access keys secure and change them periodically for security purposes. To change an access key, delete it and create a new one.
- APM allows you to encrypt and decrypt the SK in the apm.config file.
+APM allows you to encrypt and decrypt the SK in the apm.config file.
The encryption and decryption process is as follows:
-- Compile a Java class, for example, com.demo.DecryptDemo, and add a decryption method, for example, decrypt both the input and output to character strings.
- Compile the decryption method to decrypt the SK and return the decrypted value.
- Pack the com.demo.DecryptDemo class into a JAR package and place this JAR package and its dependent packages in the apm-javaagent/ext folder of JavaAgent.
- Add the following content to the apm.config file:
decrypt.className=com.demo.DecryptDemo
+- Compile a Java class, for example, com.demo.DecryptDemo, and add a decryption method, for example, decrypt both the input and output to character strings.
- Compile the decryption method to decrypt the SK and return the decrypted value.
- Pack the com.demo.DecryptDemo class into a JAR package and place this JAR package and its dependent packages in the apm-javaagent/ext folder of JavaAgent.
- Add the following content to the apm.config file:
decrypt.className=com.demo.DecryptDemo
decrypt.methodName=decrypt
-secret.key={Character string encrypted by users}
+secret.key={Character string encrypted by users}
Adding an Access Key
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose System Management > Access Keys.
- On the page that is displayed, click Add Access Key.Figure 1 Adding an AK/SK+
diff --git a/docs/apm/umn/apm_07_0035.html b/docs/apm/umn/apm_07_0035.html index bd7b98429..6f7005de8 100644 --- a/docs/apm/umn/apm_07_0035.html +++ b/docs/apm/umn/apm_07_0035.html @@ -2,12 +2,11 @@Adding an Access Key
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose System Management > Access Keys.
- On the page that is displayed, click Add Access Key.Figure 1 Adding an AK/SK
- Add an access key description and click Yes to generate an access key.
To modify the description, click Modify in the Operation column in the row that contains the target access key.
General Configuration
diff --git a/docs/apm/umn/apm_07_0039.html b/docs/apm/umn/apm_07_0039.html index 487282a82..efe337940 100644 --- a/docs/apm/umn/apm_07_0039.html +++ b/docs/apm/umn/apm_07_0039.html @@ -8,7 +8,12 @@On the General Configuration page, you can determine whether to collect data through bytecode instrumentation, and specify the slow request threshold and maximum number of rows to collect.
-- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose System Management > General Configuration.Figure 1 Modifying general configuration+
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose System Management > General Configuration.Figure 1 Modifying general configuration
- Stop Collecting Data Through Bytecode Instrumentation
Enable or disable this function as required. Data such as JVM metrics will always be collected using MBeans. The default value is No.
-+ When the Stop Collecting Data Through Bytecode Instrumentation option is enabled, data will no longer be collected through bytecode instrumentation. Data such as JVM, GC, and Tomcat thread metrics can still be collected using MBeans.
-Note: When the Stop Collecting Data Through Bytecode Instrumentation option is enabled, data will no longer be collected through bytecode instrumentation. Data such as JVM, GC, and Tomcat thread metrics can still be collected using MBeans.
- Slow Request Threshold
If this threshold is reached, more samples will be collected during intelligent sampling. The default value is 800.
- - Max. Collected Data Rows
If this value is reached, data will not be collected to prevent excessive memory usage. The default value is 499.
+ - Max. Collected Data Rows
If this value is reached, data will not be collected to prevent excessive memory usage. The default value is 500.
- Stop Collecting Data Through Bytecode Instrumentation
- Basic information
2025-02-25
+2025-03-20
+1. Optimized frontend pages.
+2025-02-25
1. Added the description for httpClientMaxRows in Configuring the HttpClient Monitoring Item.
Agent Count
APM can count the Agents used by tenants. You can view the number of Agents by time, region, or Agent type.
-- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation tree, choose System Management > Agent Count.Figure 1 Agent counting+
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation tree, choose System Management > Agent Count.Figure 1 Agent counting
- Current Agent: number of Agents used by the current tenant.
- Historical Agent: number of Agents used in each hour of today, yesterday, or a custom day.
Checking the Number of Agents Used by an Application
- In the navigation pane, choose Application Monitoring > Metrics.
- On the displayed page, select an application to view. The Application Info tab page is displayed by default.
- Switch to the Agent Count tab page to view the number of Agents used by the current application.Figure 2 Agent countingdiff --git a/docs/apm/umn/apm_07_0055.html b/docs/apm/umn/apm_07_0055.html index 3d2f0c71f..87dd7a6e0 100644 --- a/docs/apm/umn/apm_07_0055.html +++ b/docs/apm/umn/apm_07_0055.html @@ -1,8 +1,11 @@
Configuring the Exception Monitoring Item
-On the Modify Exception Monitoring Configuration page, set the following parameters:
-- Collection Interval: The default value is 60s and cannot be changed.
- Determine Trace Exception upon Log Error Detection: The default value is Yes. If Use default value is selected, the value of the inherited tag is preferentially used.
+Constraints
To record thread names in logs, you need to add %thread to the logback.xml file.
+
+
On the Modify Exception Monitoring Configuration page, set the following parameters:
+- Collection Interval: The default value is 60s and cannot be changed.
- Determine Trace Exception upon Log Error Detection: The default value is Yes. If Use default value is selected, the value of the inherited tag is preferentially used.
- Associating Service Logs with TraceId: The default value is No. If Use default value is selected, the value of the inherited tag is preferentially used.
+ + \ No newline at end of file diff --git a/docs/apm/umn/apm_07_0059.html b/docs/apm/umn/apm_07_0059.html index 2bc55c20f..b1bfa30aa 100644 --- a/docs/apm/umn/apm_07_0059.html +++ b/docs/apm/umn/apm_07_0059.html @@ -2,11 +2,10 @@@@ -10,3 +13,10 @@Recommended Alarm Templates
APM provides recommended alarm templates.
-diff --git a/docs/apm/umn/apm_07_0061.html b/docs/apm/umn/apm_07_0061.html index 3bce6c753..b6de6729d 100644 --- a/docs/apm/umn/apm_07_0061.html +++ b/docs/apm/umn/apm_07_0061.html @@ -2,73 +2,71 @@Using Recommended Alarm Templates
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click an application. The metric details page of the application is displayed.
- Choose Alarm Templates > Recommendation Template to view the configured alarm templates.Figure 1 Viewing recommended alarm templates+
Using Recommended Alarm Templates
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click an application. The metric details page of the application is displayed.
- Choose Alarm Templates > Recommendation Template to view the configured alarm templates.Figure 1 Viewing recommended alarm templates
- Click View Details in the Operation column in the row that contains the target alarm template.Figure 2 Recommended template list
- Click Copy to copy the recommended template to the template list. You can customize the template name as required.Figure 3 Copying an alarm template-
- Click Yes. The copied alarm template is displayed on the template list.Figure 4 Returning to the alarm template page-
Figure 5 Returning to the alarm template page+
- Click Yes. The copied alarm template is displayed on the template list.Figure 4 Returning to the alarm template page
- Click Modify in the Operation column and bind nodes to make the copied template to take effect.
Web Container
This function monitors web containers, including Tomcat. This section focuses on Tomcat monitoring.
-Going to the Web Container Page
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. - Click the Web Container tab. By default, the Tomcat monitoring information of all instances is displayed. For details about the metrics, see Table 1.Figure 1 Going to the web container page- -
Table 1 Tomcat monitoring parameters Metric Set
+Going to the Web Container Page
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. - Click the Web Container tab. By default, the Tomcat monitoring information of all instances is displayed. For details about the metrics, see Table 1.
+
-Table 1 Tomcat monitoring parameters Metric Set
Metric
+Metric
Description
+Description
Tomcat port monitoring
+Tomcat port monitoring
name
+name
Port name.
+Port name.
Current Threads
+Current Threads
Number of current threads on the port.
+Number of current threads on the port.
Busy Threads
+Busy Threads
Number of busy threads on the port at the time of collection.
+Number of busy threads on the port at the time of collection.
Peak Busy Threads
+Peak Busy Threads
Maximum number of busy threads on the port in a collection period.
+Maximum number of busy threads on the port in a collection period.
Max Threads
+Max Threads
Maximum number of threads on the port.
+Maximum number of threads on the port.
Max Connections
+Max Connections
Maximum number of connections on the port.
+Maximum number of connections on the port.
Current Connections
+Current Connections
Number of current connections of the port at the time of collection.
+Number of current connections of the port at the time of collection.
Peak Connections
+Peak Connections
Maximum number of connections on the port in a collection period.
+Maximum number of connections on the port in a collection period.
Version
+Version
Version
+Version
Tomcat version.
+Tomcat version.
- Click a number in blue (such as those in the Current Threads, Busy Threads, or Peak Busy Threads column) to view the trend graph of the target web container in the specified period.
- Click a version in the Version column to view details.
- On the displayed Web Container tab page, select a target instance and monitoring item to view the monitoring data in different metric sets.Figure 2 Selecting an instance and monitoring item-
- Select a time range. Default: Last 20 minutes.
Options: Last 20 minutes, Last hour, Last 3 hours, Last 6 hours, Last day, Today, Yesterday, Last week, Last month, or Custom.
-Figure 3 Selecting a time range-
- Click
in the upper right corner of the list and select the metric data you want to view.
- Click a number in pink (such as those in the Current Threads, Busy Threads, or Peak Busy Threads column) to view the trend graph of the target web container in a specified period.
- Click a version in the Version column to view details.
- On the displayed Web Container tab page, select a target instance and monitoring item to view the monitoring data in different metric sets.
- Select a time range. Default: Last 20 minutes.
Options: Last 20 minutes, Last hour, Last 3 hours, Last 6 hours, Last day, Today, Yesterday, Last week, Last month, or Custom.
+Figure 1 Selecting a time range+- Click
in the upper right corner of the list and select the metric data you want to view.diff --git a/docs/apm/umn/apm_07_0067.html b/docs/apm/umn/apm_07_0067.html index f866fdd3e..98678ba79 100644 --- a/docs/apm/umn/apm_07_0067.html +++ b/docs/apm/umn/apm_07_0067.html @@ -2,14 +2,9 @@- - \ No newline at end of file diff --git a/docs/apm/umn/apm_07_0151.html b/docs/apm/umn/apm_07_0151.html index fd4689dae..8ff144eec 100644 --- a/docs/apm/umn/apm_07_0151.html +++ b/docs/apm/umn/apm_07_0151.html @@ -1,7 +1,7 @@Topology
The topology displays the call relationships between services within a period. The statistics can be collected from the caller or the callee. You can also view the trend. On the topology, you can view the call relationships between services and check whether the calls between services are normal to quickly locate faults. The application relationships, call data (service and instance metrics), and health status are clearly displayed.
-@@ -19,10 +14,3 @@Viewing the Topology
- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. - Switch to the Topology tab page. The call trend of the selected instance is displayed.Figure 1 Viewing the topology-
- Click
next to Display only calls between components.Figure 2 Displaying only calls between components-
When the button turns blue, only the calls between components are displayed.
-Figure 3 Calls between components-
- Click Show All to display all call relationships of the selected instance in a specified time range.Figure 4 Showing all-
- Click Reset Layout to restore to the initial topology.
- Select the refresh mode and time. Default: Manual Refresh. In addition, Automatic refresh in 1 minute, Automatic refresh in 5 minutes, and Automatic refresh in 15 minutes are supported.Figure 5 Selecting a refresh mode-
- Select a time dimension. Default: Last 20 minutes.
Options: Last 20 minutes, Last hour, Last 3 hours, Last 6 hours, Last day, Today, Yesterday, Last week, Last month, or Custom.
-Figure 6 Selecting a time dimension+
Viewing the Topology
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- In the tree on the left, click
next to the target environment. - Switch to the Topology tab page. The call trend of the selected instance is displayed.
- Click next to Display only calls between components.
When the button turns pink, only the calls between components are displayed.
+ - Click Show All to display all call relationships of the selected instance in a specified time range.
- Click Reset Layout to restore to the initial topology.
- Select the refresh mode and time. Default: Manual Refresh. In addition, Automatic refresh in 1 minute, Automatic refresh in 5 minutes, and Automatic refresh in 15 minutes are supported.
- Select a time range. Default: Last 20 minutes.
Options: Last 20 minutes, Last hour, Last 3 hours, Last 6 hours, Last day, Today, Yesterday, Last week, Last month, or Custom.
+- Click
to refresh the topology.
- Click
Creating an Application
-- - \ No newline at end of file diff --git a/docs/apm/umn/apm_07_0152.html b/docs/apm/umn/apm_07_0152.html index b9e8e2b3d..78b2d3a0d 100644 --- a/docs/apm/umn/apm_07_0152.html +++ b/docs/apm/umn/apm_07_0152.html @@ -1,7 +1,7 @@- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- Click
on the right of Application Metric to create an application.Figure 1 Creating an application+
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- Click on the right of Application Metric to create an application.Figure 1 Creating an application
- In the displayed dialog box, set application parameters.-
Table 1 Parameters for creating an application Parameter
Description
Description of the application. Enter up to 1000 characters.
+Description of the application. Enter up to 1,000 characters.
- Click Confirm.+
After an application is created, connect it to APM for monitoring. For details about the access method, see Monitoring Java Applications.
- - Click Confirm.
After an application is created, connect it to APM for monitoring. For details about the access method, see Monitoring Java Applications.
@@ -44,10 +43,3 @@
Configuring an Application and Sub-application
-- Log in to the management console.
- Click
on the left and choose Application > Application Performance Management. - In the navigation pane, choose Application Monitoring > Metrics.
- Click
next to the application or sub-application name in the tree.Figure 1 Configuring an application and sub-application+
- Log in to the management console.
- Click on the left and choose Application > Application Performance Management.
- In the navigation pane, choose Application Monitoring > Metrics.
- Click
next to the application or sub-application name in the tree.Figure 1 Configuring an application and sub-application - Configure the application and sub-application according to Table 1.
- Basic information
- Basic information
- Enter basic information and then click Next.
Overview
+Introduction
APM Agents periodically collect performance metric data to measure the overall health status of applications. They can collect the metric data of JVM, GC, service calls, exceptions, external calls, database access, and middleware, helping you comprehensively monitor application running.
APM has strict definitions on metric data collection. Each type of data to be collected corresponds to a collector. For example, for JVM data of Java applications, a JVM collector is provided. A collector collects data of multiple metric sets. For details about collectors and metric sets, see Collection Center.
After collectors are deployed in the environment, monitoring items are generated. During data collection, the monitoring items determine data structures and collection behaviors.
Monitoring Item Types
Agents automatically discover collection plug-ins and instantiate collectors to form monitoring items. Monitoring items are instantiated in an environment.
There are many types of collectors, which are hard to distinguish. The system backend groups collectors for easy data query.
-+ The Metrics page displays only the involved monitoring item metrics of connected applications.
-The Metrics page displays only the involved monitoring item metrics of connected applications.
Based on collector functions, monitoring items can be classified into:
-diff --git a/docs/apm/umn/apm_07_0006.html b/docs/apm/umn/apm_07_0006.html index fe93bcc0d..9c548679d 100644 --- a/docs/apm/umn/apm_07_0006.html +++ b/docs/apm/umn/apm_07_0006.html @@ -3,126 +3,122 @@Monitoring Item Configuration
Collectors corresponding to monitoring items define collection parameters. You can modify collection parameters on the page as required. These parameters will be delivered to Agents with heartbeat parameters to change collection behaviors. By default, Redis instruction content is not collected for security purposes. If necessary, modify collection parameters to collect specific instruction data. Collection parameters can also be defined on environment tags. Collectors automatically inherit collection parameter attributes of corresponding environment tags. In this way, configuration is automated.
URL
This function monitors the calls of the current application by external services. It includes URL, Dubbo server, CSE server, CSEProvider cluster, and FunctionGraph monitoring. This type of monitoring item demonstrates the actual external status of the entire service. For example, if the average response time of a URL is long, it means that external users take a long time to query the corresponding data.
This section focuses on URL monitoring.
-Going to the URL Page
Going to the URL Page
Viewing URL Monitoring Data
URL summary
For common URL calls, the system collects the metrics of each URL. For details about the metrics, see Table 1.
-Figure 3 URL summary under URL monitoring-
Table 1 Parameters of the URL summary Metric Set
+-Table 1 Parameters of the URL summary Metric Set
Metric
+Metric
Description
+Description
URL summary
+URL summary
url
+url
URL.
+URL.
method
+method
Request HTTP method.
+Request HTTP method.
Calls
+Calls
Number of times that the URL is called.
+Number of times that the URL is called.
Avg RT (ms)
+Avg RT (ms)
Average response time of the URL in a collection period.
+Average response time of the URL in a collection period.
Errors
+Errors
Number of call errors of the URL.
+Number of call errors of the URL.
Max Concurrency
+Max Concurrency
Maximum concurrency of the URL.
+Maximum concurrency of the URL.
Max RT (ms)
+Max RT (ms)
Maximum response time of the URL in a collection period.
+Maximum response time of the URL in a collection period.
Apdex
+Apdex
Application performance index (Apdex), which indicates users' satisfaction. The value ranges from 0 to 1. The closer the value is to 1, the higher the satisfaction is.
+Application performance index (Apdex), which indicates users' satisfaction. The value ranges from 0 to 1. The closer the value is to 1, the higher the satisfaction is.
0 ms–10 ms
+0 ms–10 ms
Number of requests with 0 ms–10 ms response time.
+Number of requests with 0 ms–10 ms response time.
10 ms–100 ms
+10 ms–100 ms
Number of requests with 10 ms–100 ms response time.
+Number of requests with 10 ms–100 ms response time.
100 ms–500 ms
+100 ms–500 ms
Number of requests with 100 ms–500 ms response time.
+Number of requests with 100 ms–500 ms response time.
500 ms–1s
+500 ms–1s
Number of requests with 500 ms–1s response time.
+Number of requests with 500 ms–1s response time.
1s–10s
+1s–10s
Number of requests with 1s–10s response time.
+Number of requests with 1s–10s response time.
10s–n
+10s–n
Number of requests with response time longer than 10s.
+Number of requests with response time longer than 10s.
Status code summary
APM supports status code-based summary. The system collects the metrics of each URL. For details about the metrics, see Table 2.
-Figure 4 Status code summary under URL monitoring-
Table 2 Parameters of status code summary Metric Set
+Table 2 Parameters of status code summary Metric Set
Metric
+Metric
Description
+Description
Status code summary
+Status code summary
code
+code
Status code.
+Status code.
Count
+Count
Number of times that the status code occurred.
+Number of times that the status code occurred.
Latest URL
+Latest URL
Sample URL which returns the status code in a collection period.
+Sample URL which returns the status code in a collection period.
Cluster summary
APM can summarize metrics by cluster. For details about the metrics, see Table 3.
-Figure 5 Cluster summary under URL monitoring-
Table 3 Parameters of the cluster summary Metric Set
+-Table 3 Parameters of the cluster summary Metric Set
Parameter
+Parameter
Description
+Description
Cluster summary
+Cluster summary
Cluster ID
+Cluster ID
Cluster ID of the caller.
+Cluster ID of the caller.
Calls
+Calls
Number of times the cluster is called.
+Number of times the cluster is called.
Avg RT (ms)
+Avg RT (ms)
Average response time in a collection period.
+Average response time in a collection period.
Errors
+Errors
Number of times that the cluster fails to be called.
+Number of times that the cluster fails to be called.
Click a number in blue (such as those in the Calls or Avg RT (ms) column) to view more details.
+Click a number in pink (such as those in the Calls or Avg RT (ms) column) to view more details.
Overview
View the metric trend of the selected instance on the Overview tab page. For details about the metrics, see Table 4.
-Figure 6 Overview under URL monitoring-
Table 4 Overview metrics Metric Set
+Table 4 Overview metrics Metric Set
Metric
+Metric
Description
+Description
Overview
+Overview
Total Requests
+Total Requests
Total number of URL requests.
+Total number of URL requests.
Avg RT (ms)
+Avg RT (ms)
Average response time of the URL.
+Average response time of the URL.
Errors
+Errors
Total number of URL errors.
+Total number of URL errors.
Apdex
+Apdex
Users' satisfaction with the URL.
+Users' satisfaction with the URL.
JVM
This function monitors JVMInfo, JVMMonitor, GC, thread, and JavaMethod.
-Going to the JVM Page
- Overview
- Log in to the APM console.
