From 03b45d2fa6b78fb1a0c4dbb96f97fa6d00240fda Mon Sep 17 00:00:00 2001 From: Ax1an Date: Fri, 12 Mar 2021 07:41:32 +0800 Subject: [PATCH] Fix some comments and documentation (#6534) --- .../jdbc/mysql/v5/define/CallableInstrumentation.java | 5 +++-- .../mysql/v5/define/PreparedStatementInstrumentation.java | 6 +++--- .../jdbc/mysql/v6/define/CallableInstrumentation.java | 5 +++-- .../mysql/v6/define/PreparedStatementInstrumentation.java | 6 +++--- docs/en/setup/backend/backend-alarm.md | 2 +- 5 files changed, 13 insertions(+), 11 deletions(-) diff --git a/apm-sniffer/apm-sdk-plugin/mysql-5.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v5/define/CallableInstrumentation.java b/apm-sniffer/apm-sdk-plugin/mysql-5.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v5/define/CallableInstrumentation.java index 57511ef15..364a06042 100644 --- a/apm-sniffer/apm-sdk-plugin/mysql-5.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v5/define/CallableInstrumentation.java +++ b/apm-sniffer/apm-sdk-plugin/mysql-5.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v5/define/CallableInstrumentation.java @@ -28,8 +28,9 @@ import static net.bytebuddy.matcher.ElementMatchers.named; import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName; /** - * {@link CallableInstrumentation} define that the mysql-2.x plugin intercepts the following methods in the - * com.mysql.jdbc.CallableStatement 1. execute 2. executeQuery 3. executeUpdate + * {@link CallableInstrumentation} define that the mysql-5.x plugin intercepts the following methods in the + * com.mysql.jdbc.CallableStatement class: + * 1. execute 2. executeQuery 3. executeUpdate */ public class CallableInstrumentation extends AbstractMysqlInstrumentation { private static final String ENHANCE_CLASS = "com.mysql.jdbc.CallableStatement"; diff --git a/apm-sniffer/apm-sdk-plugin/mysql-5.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v5/define/PreparedStatementInstrumentation.java b/apm-sniffer/apm-sdk-plugin/mysql-5.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v5/define/PreparedStatementInstrumentation.java index 959c9cbd8..36a631fbe 100644 --- a/apm-sniffer/apm-sdk-plugin/mysql-5.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v5/define/PreparedStatementInstrumentation.java +++ b/apm-sniffer/apm-sdk-plugin/mysql-5.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v5/define/PreparedStatementInstrumentation.java @@ -30,9 +30,9 @@ import net.bytebuddy.description.method.MethodDescription; import net.bytebuddy.matcher.ElementMatcher; /** - * {@link PreparedStatementInstrumentation} define that the mysql-2.x plugin intercepts the following methods in the - * com.mysql.jdbc.JDBC42PreparedStatement, com.mysql.jdbc.PreparedStatement and com.mysql.cj.jdbc.PreparedStatement - * class: 1. execute 2. executeQuery 3. executeUpdate 4. executeLargeUpdate 5. addBatch + * {@link PreparedStatementInstrumentation} define that the mysql-5.x plugin intercepts the following methods in the + * com.mysql.jdbc.PreparedStatement class: + * 1. execute 2. executeQuery 3. executeUpdate 4. executeLargeUpdate */ public class PreparedStatementInstrumentation extends AbstractMysqlInstrumentation { diff --git a/apm-sniffer/apm-sdk-plugin/mysql-6.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v6/define/CallableInstrumentation.java b/apm-sniffer/apm-sdk-plugin/mysql-6.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v6/define/CallableInstrumentation.java index 4af706307..92009a386 100644 --- a/apm-sniffer/apm-sdk-plugin/mysql-6.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v6/define/CallableInstrumentation.java +++ b/apm-sniffer/apm-sdk-plugin/mysql-6.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v6/define/CallableInstrumentation.java @@ -28,8 +28,9 @@ import static net.bytebuddy.matcher.ElementMatchers.named; import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName; /** - * {@link CallableInstrumentation} define that the mysql-2.x plugin intercepts the following methods in the - * com.mysql.jdbc.CallableStatement 1. execute 2. executeQuery 3. executeUpdate + * {@link CallableInstrumentation} define that the mysql-6.x plugin intercepts the following methods in the + * com.mysql.jdbc.cj.CallableStatement class: + * 1. execute 2. executeQuery 3. executeUpdate */ public class CallableInstrumentation extends AbstractMysqlInstrumentation { private static final String ENHANCE_CLASS = "com.mysql.jdbc.cj.CallableStatement"; diff --git a/apm-sniffer/apm-sdk-plugin/mysql-6.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v6/define/PreparedStatementInstrumentation.java b/apm-sniffer/apm-sdk-plugin/mysql-6.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v6/define/PreparedStatementInstrumentation.java index c0b3edfcc..843071cd4 100644 --- a/apm-sniffer/apm-sdk-plugin/mysql-6.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v6/define/PreparedStatementInstrumentation.java +++ b/apm-sniffer/apm-sdk-plugin/mysql-6.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/mysql/v6/define/PreparedStatementInstrumentation.java @@ -28,9 +28,9 @@ import static net.bytebuddy.matcher.ElementMatchers.named; import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName; /** - * {@link PreparedStatementInstrumentation} define that the mysql-2.x plugin intercepts the following methods in the - * com.mysql.jdbc.JDBC42PreparedStatement, com.mysql.jdbc.PreparedStatement and com.mysql.cj.jdbc.PreparedStatement - * class: 1. execute 2. executeQuery 3. executeUpdate 4. executeLargeUpdate 5. addBatch + * {@link PreparedStatementInstrumentation} define that the mysql-6.x plugin intercepts the following methods in the + * com.mysql.cj.jdbc.PreparedStatement class: + * 1. execute 2. executeQuery 3. executeUpdate 4. executeLargeUpdate */ public class PreparedStatementInstrumentation extends AbstractMysqlInstrumentation { diff --git a/docs/en/setup/backend/backend-alarm.md b/docs/en/setup/backend/backend-alarm.md index 978abc4d4..e7ba3fba7 100644 --- a/docs/en/setup/backend/backend-alarm.md +++ b/docs/en/setup/backend/backend-alarm.md @@ -25,7 +25,7 @@ Alarm rule is constituted by following keys - **Include names**. The following entity names are included in this rule. Please follow [Entity name define](#entity-name). - **Exclude names**. The following entity names are excluded in this rule. Please follow [Entity name define](#entity-name). - **Include names regex**. Provide a regex to include the entity names. If both setting the include name list and include name regex, both rules will take effect. -- **Exclude names regex**. Provide a regex to exclude the exclude names. If both setting the exclude name list and exclude name regex, both rules will take effect. +- **Exclude names regex**. Provide a regex to exclude the entity names. If both setting the exclude name list and exclude name regex, both rules will take effect. - **Include labels**. The following labels of the metric are included in this rule. - **Exclude labels**. The following labels of the metric are excluded in this rule. - **Include labels regex**. Provide a regex to include labels. If both setting the include label list and include label regex, both rules will take effect.