You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by su...@apache.org on 2023/03/23 04:13:15 UTC

[shardingsphere] branch master updated: Code format for agent (#24772)

This is an automated email from the ASF dual-hosted git repository.

sunnianjun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git


The following commit(s) were added to refs/heads/master by this push:
     new a3c5a94973d Code format for agent (#24772)
a3c5a94973d is described below

commit a3c5a94973d1272def37b88326f868aefbfa1d8a
Author: Liang Zhang <zh...@apache.org>
AuthorDate: Thu Mar 23 12:13:08 2023 +0800

    Code format for agent (#24772)
---
 .../PrometheusMetricsCollectorFactory.java         |  2 +-
 .../type/PrometheusMetricsCounterCollector.java    |  2 +-
 .../type/PrometheusMetricsGaugeCollector.java      |  2 +-
 ...rometheusMetricsGaugeMetricFamilyCollector.java |  2 +-
 .../type/PrometheusMetricsHistogramCollector.java  |  2 +-
 .../type/PrometheusMetricsSummaryCollector.java    |  2 +-
 .../exoprter/PrometheusMetricsExporter.java        |  2 +-
 .../AbstractJDBCExecutorCallbackAdviceTest.java    | 30 ++++++++++------------
 ...OpenTelemetryTracingPluginLifecycleService.java |  3 +--
 .../constant/OpenTelemetryConstants.java           |  6 +++--
 ...penTelemetryJDBCExecutorCallbackAdviceTest.java | 12 ++++-----
 .../OpenTracingJDBCExecutorCallbackAdviceTest.java | 12 ++++-----
 12 files changed, 37 insertions(+), 40 deletions(-)

diff --git a/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/PrometheusMetricsCollectorFactory.java b/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/PrometheusMetricsCollectorFactory.java
index 8917bcafc88..1c8bfc5c7b7 100644
--- a/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/PrometheusMetricsCollectorFactory.java
+++ b/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/PrometheusMetricsCollectorFactory.java
@@ -27,7 +27,7 @@ import org.apache.shardingsphere.agent.plugin.metrics.prometheus.collector.type.
 import org.apache.shardingsphere.agent.plugin.metrics.prometheus.collector.type.PrometheusMetricsSummaryCollector;
 
 /**
- * Prometheus metrics collector factory.
+ * Metrics collector factory of Prometheus.
  */
 public final class PrometheusMetricsCollectorFactory implements MetricsCollectorFactory {
     
diff --git a/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsCounterCollector.java b/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsCounterCollector.java
index 201cf825112..746a4d1808d 100644
--- a/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsCounterCollector.java
+++ b/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsCounterCollector.java
@@ -22,7 +22,7 @@ import org.apache.shardingsphere.agent.plugin.metrics.core.config.MetricConfigur
 import org.apache.shardingsphere.agent.plugin.metrics.core.collector.type.CounterMetricsCollector;
 
 /**
- * Prometheus metrics counter collector.
+ * Metrics counter collector of Prometheus.
  */
 public final class PrometheusMetricsCounterCollector implements CounterMetricsCollector {
     
diff --git a/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsGaugeCollector.java b/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsGaugeCollector.java
index 0af84ba9d67..b64581b5346 100644
--- a/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsGaugeCollector.java
+++ b/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsGaugeCollector.java
@@ -22,7 +22,7 @@ import org.apache.shardingsphere.agent.plugin.metrics.core.config.MetricConfigur
 import org.apache.shardingsphere.agent.plugin.metrics.core.collector.type.GaugeMetricsCollector;
 
 /**
- * Prometheus metrics gauge collector.
+ * Metrics gauge collector of Prometheus.
  */
 public final class PrometheusMetricsGaugeCollector implements GaugeMetricsCollector {
     
diff --git a/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsGaugeMetricFamilyCollector.java b/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsGaugeMetricFamilyCollector.java
index 80459600dcd..3cb589a0f57 100644
--- a/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsGaugeMetricFamilyCollector.java
+++ b/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsGaugeMetricFamilyCollector.java
@@ -24,7 +24,7 @@ import org.apache.shardingsphere.agent.plugin.metrics.core.config.MetricConfigur
 import java.util.List;
 
 /**
- * Prometheus metrics gauge metric family collector.
+ * Metrics gauge metric family collector of Prometheus.
  */
 public final class PrometheusMetricsGaugeMetricFamilyCollector implements GaugeMetricFamilyMetricsCollector {
     
diff --git a/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsHistogramCollector.java b/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsHistogramCollector.java
index 8e78b828a50..5d9c3d5be34 100644
--- a/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsHistogramCollector.java
+++ b/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsHistogramCollector.java
@@ -25,7 +25,7 @@ import org.apache.shardingsphere.agent.plugin.metrics.core.collector.type.Histog
 import java.util.Map;
 
 /**
- * Prometheus metrics histogram collector.
+ * Metrics histogram collector of Prometheus.
  */
 public final class PrometheusMetricsHistogramCollector implements HistogramMetricsCollector {
     
diff --git a/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsSummaryCollector.java b/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsSummaryCollector.java
index 8de6f578b61..18a88275793 100644
--- a/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsSummaryCollector.java
+++ b/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/collector/type/PrometheusMetricsSummaryCollector.java
@@ -22,7 +22,7 @@ import org.apache.shardingsphere.agent.plugin.metrics.core.config.MetricConfigur
 import org.apache.shardingsphere.agent.plugin.metrics.core.collector.type.SummaryMetricsCollector;
 
 /**
- * Prometheus metrics summary collector.
+ * Metrics summary collector of Prometheus.
  */
 public final class PrometheusMetricsSummaryCollector implements SummaryMetricsCollector {
     
diff --git a/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/exoprter/PrometheusMetricsExporter.java b/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/exoprter/PrometheusMetricsExporter.java
index 45c0af80761..f0cf50abc87 100644
--- a/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/exoprter/PrometheusMetricsExporter.java
+++ b/agent/plugins/metrics/type/prometheus/src/main/java/org/apache/shardingsphere/agent/plugin/metrics/prometheus/exoprter/PrometheusMetricsExporter.java
@@ -26,7 +26,7 @@ import java.util.Collections;
 import java.util.List;
 
 /**
- * Prometheus metrics exporter.
+ * Metrics exporter of Prometheus.
  */
 @RequiredArgsConstructor
 public final class PrometheusMetricsExporter extends Collector {
diff --git a/agent/plugins/tracing/test/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/advice/AbstractJDBCExecutorCallbackAdviceTest.java b/agent/plugins/tracing/test/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/advice/AbstractJDBCExecutorCallbackAdviceTest.java
index d9696cfe04b..cbf8cb2fa91 100644
--- a/agent/plugins/tracing/test/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/advice/AbstractJDBCExecutorCallbackAdviceTest.java
+++ b/agent/plugins/tracing/test/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/advice/AbstractJDBCExecutorCallbackAdviceTest.java
@@ -17,11 +17,12 @@
 
 package org.apache.shardingsphere.agent.plugin.tracing.advice;
 
+import lombok.AccessLevel;
 import lombok.Getter;
 import lombok.SneakyThrows;
 import org.apache.shardingsphere.agent.api.advice.TargetAdviceObject;
-import org.apache.shardingsphere.agent.plugin.tracing.TracingAgentExtension;
 import org.apache.shardingsphere.agent.plugin.tracing.MockDataSourceMetaData;
+import org.apache.shardingsphere.agent.plugin.tracing.TracingAgentExtension;
 import org.apache.shardingsphere.infra.database.metadata.DataSourceMetaData;
 import org.apache.shardingsphere.infra.database.type.DatabaseType;
 import org.apache.shardingsphere.infra.database.type.dialect.MySQLDatabaseType;
@@ -44,41 +45,36 @@ import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
 @ExtendWith(TracingAgentExtension.class)
+@Getter
 public abstract class AbstractJDBCExecutorCallbackAdviceTest implements AdviceTestBase {
     
-    @Getter
+    public static final String DATA_SOURCE_NAME = "mock.db";
+    
+    public static final String SQL = "SELECT 1";
+    
+    private final Map<String, Object> extraMap = new HashMap<>();
+    
     private TargetAdviceObject targetObject;
     
+    @Getter(AccessLevel.NONE)
     private Object attachment;
     
-    @Getter
     private JDBCExecutionUnit executionUnit;
     
-    @Getter
-    private Map<String, Object> extraMap;
-    
+    @Getter(AccessLevel.NONE)
     private Map<String, DatabaseType> storageTypes;
     
-    @Getter
-    private String dataSourceName;
-    
-    @Getter
-    private String sql;
-    
     @SuppressWarnings({"rawtypes", "unchecked"})
     @SneakyThrows({ReflectiveOperationException.class, SQLException.class})
     @Override
     public void prepare() {
-        extraMap = new HashMap<>();
-        dataSourceName = "mock.db";
-        sql = "select 1";
         Statement statement = mock(Statement.class);
         Connection connection = mock(Connection.class);
         DatabaseMetaData databaseMetaData = mock(DatabaseMetaData.class);
         when(databaseMetaData.getURL()).thenReturn("mock_url");
         when(connection.getMetaData()).thenReturn(databaseMetaData);
         when(statement.getConnection()).thenReturn(connection);
-        executionUnit = new JDBCExecutionUnit(new ExecutionUnit(dataSourceName, new SQLUnit(sql, Collections.emptyList())), null, statement);
+        executionUnit = new JDBCExecutionUnit(new ExecutionUnit(DATA_SOURCE_NAME, new SQLUnit(SQL, Collections.emptyList())), null, statement);
         JDBCExecutorCallback mockedJDBCExecutorCallback = mock(JDBCExecutorCallback.class, invocation -> {
             switch (invocation.getMethod().getName()) {
                 case "getAttachment":
@@ -93,7 +89,7 @@ public abstract class AbstractJDBCExecutorCallbackAdviceTest implements AdviceTe
         Map<String, DataSourceMetaData> cachedDatasourceMetaData = (Map<String, DataSourceMetaData>) Plugins.getMemberAccessor()
                 .get(JDBCExecutorCallback.class.getDeclaredField("CACHED_DATASOURCE_METADATA"), mockedJDBCExecutorCallback);
         cachedDatasourceMetaData.put("mock_url", new MockDataSourceMetaData());
-        storageTypes = Collections.singletonMap(dataSourceName, new MySQLDatabaseType());
+        storageTypes = Collections.singletonMap(DATA_SOURCE_NAME, new MySQLDatabaseType());
         Plugins.getMemberAccessor().set(JDBCExecutorCallback.class.getDeclaredField("storageTypes"), mockedJDBCExecutorCallback, storageTypes);
         targetObject = (TargetAdviceObject) mockedJDBCExecutorCallback;
     }
diff --git a/agent/plugins/tracing/type/opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/OpenTelemetryTracingPluginLifecycleService.java b/agent/plugins/tracing/type/opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/OpenTelemetryTracingPluginLifecycleService.java
index b314ccce610..43b7d7a8079 100644
--- a/agent/plugins/tracing/type/opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/OpenTelemetryTracingPluginLifecycleService.java
+++ b/agent/plugins/tracing/type/opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/OpenTelemetryTracingPluginLifecycleService.java
@@ -26,7 +26,7 @@ import org.apache.shardingsphere.agent.spi.PluginLifecycleService;
 /**
  * Open telemetry tracing plugin lifecycle service.
  */
-public class OpenTelemetryTracingPluginLifecycleService implements PluginLifecycleService {
+public final class OpenTelemetryTracingPluginLifecycleService implements PluginLifecycleService {
     
     @Override
     public void start(final PluginConfiguration pluginConfig, final boolean isEnhancedForProxy) {
@@ -42,7 +42,6 @@ public class OpenTelemetryTracingPluginLifecycleService implements PluginLifecyc
     
     @Override
     public void close() {
-        
     }
     
     @Override
diff --git a/agent/plugins/tracing/type/opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/constant/OpenTelemetryConstants.java b/agent/plugins/tracing/type/opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/constant/OpenTelemetryConstants.java
index 4735e04ffdf..4150b32c0a6 100644
--- a/agent/plugins/tracing/type/opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/constant/OpenTelemetryConstants.java
+++ b/agent/plugins/tracing/type/opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/constant/OpenTelemetryConstants.java
@@ -20,9 +20,11 @@ package org.apache.shardingsphere.agent.plugin.tracing.opentelemetry.constant;
 import lombok.AccessLevel;
 import lombok.NoArgsConstructor;
 
+/**
+ * OpenTelemetry constants.
+ */
 @NoArgsConstructor(access = AccessLevel.PRIVATE)
-public class OpenTelemetryConstants {
+public final class OpenTelemetryConstants {
     
     public static final String TRACER_NAME = "shardingsphere-agent";
-    
 }
diff --git a/agent/plugins/tracing/type/opentelemetry/src/test/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/advice/OpenTelemetryJDBCExecutorCallbackAdviceTest.java b/agent/plugins/tracing/type/opentelemetry/src/test/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/advice/OpenTelemetryJDBCExecutorCallbackAdviceTest.java
index 2e601450f20..5d935cb5dfc 100644
--- a/agent/plugins/tracing/type/opentelemetry/src/test/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/advice/OpenTelemetryJDBCExecutorCallbackAdviceTest.java
+++ b/agent/plugins/tracing/type/opentelemetry/src/test/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/advice/OpenTelemetryJDBCExecutorCallbackAdviceTest.java
@@ -75,9 +75,9 @@ public final class OpenTelemetryJDBCExecutorCallbackAdviceTest extends AbstractJ
         assertThat(spanData.getName(), is("/ShardingSphere/executeSQL/"));
         Attributes attributes = spanData.getAttributes();
         assertThat(attributes.get(AttributeKey.stringKey(AttributeConstants.COMPONENT)), is(AttributeConstants.COMPONENT_NAME));
-        assertThat(attributes.get(AttributeKey.stringKey(AttributeConstants.DB_TYPE)), is(getDatabaseType(getDataSourceName())));
-        assertThat(attributes.get(AttributeKey.stringKey(AttributeConstants.DB_INSTANCE)), is(getDataSourceName()));
-        assertThat(attributes.get(AttributeKey.stringKey(AttributeConstants.DB_STATEMENT)), is(getSql()));
+        assertThat(attributes.get(AttributeKey.stringKey(AttributeConstants.DB_TYPE)), is(getDatabaseType(DATA_SOURCE_NAME)));
+        assertThat(attributes.get(AttributeKey.stringKey(AttributeConstants.DB_INSTANCE)), is(DATA_SOURCE_NAME));
+        assertThat(attributes.get(AttributeKey.stringKey(AttributeConstants.DB_STATEMENT)), is(SQL));
     }
     
     @Test
@@ -92,8 +92,8 @@ public final class OpenTelemetryJDBCExecutorCallbackAdviceTest extends AbstractJ
         assertThat(spanData.getStatus().getStatusCode(), is(StatusCode.ERROR));
         Attributes attributes = spanData.getAttributes();
         assertThat(attributes.get(AttributeKey.stringKey(AttributeConstants.COMPONENT)), is(AttributeConstants.COMPONENT_NAME));
-        assertThat(attributes.get(AttributeKey.stringKey(AttributeConstants.DB_TYPE)), is(getDatabaseType(getDataSourceName())));
-        assertThat(attributes.get(AttributeKey.stringKey(AttributeConstants.DB_INSTANCE)), is(getDataSourceName()));
-        assertThat(attributes.get(AttributeKey.stringKey(AttributeConstants.DB_STATEMENT)), is(getSql()));
+        assertThat(attributes.get(AttributeKey.stringKey(AttributeConstants.DB_TYPE)), is(getDatabaseType(DATA_SOURCE_NAME)));
+        assertThat(attributes.get(AttributeKey.stringKey(AttributeConstants.DB_INSTANCE)), is(DATA_SOURCE_NAME));
+        assertThat(attributes.get(AttributeKey.stringKey(AttributeConstants.DB_STATEMENT)), is(SQL));
     }
 }
diff --git a/agent/plugins/tracing/type/opentracing/src/test/java/org/apache/shardingsphere/agent/plugin/tracing/opentracing/advice/OpenTracingJDBCExecutorCallbackAdviceTest.java b/agent/plugins/tracing/type/opentracing/src/test/java/org/apache/shardingsphere/agent/plugin/tracing/opentracing/advice/OpenTracingJDBCExecutorCallbackAdviceTest.java
index 15f80875f10..22f569ef1f4 100644
--- a/agent/plugins/tracing/type/opentracing/src/test/java/org/apache/shardingsphere/agent/plugin/tracing/opentracing/advice/OpenTracingJDBCExecutorCallbackAdviceTest.java
+++ b/agent/plugins/tracing/type/opentracing/src/test/java/org/apache/shardingsphere/agent/plugin/tracing/opentracing/advice/OpenTracingJDBCExecutorCallbackAdviceTest.java
@@ -72,9 +72,9 @@ public final class OpenTracingJDBCExecutorCallbackAdviceTest extends AbstractJDB
         assertTrue(spans.get(0).logEntries().isEmpty());
         assertThat(span.operationName(), is("/ShardingSphere/executeSQL/"));
         assertThat(tags.get(AttributeConstants.COMPONENT), is(AttributeConstants.COMPONENT_NAME));
-        assertThat(tags.get(AttributeConstants.DB_INSTANCE), is(getDataSourceName()));
-        assertThat(tags.get(AttributeConstants.DB_TYPE), is(getDatabaseType(getDataSourceName())));
-        assertThat(tags.get(AttributeConstants.DB_STATEMENT), is(getSql()));
+        assertThat(tags.get(AttributeConstants.DB_INSTANCE), is(DATA_SOURCE_NAME));
+        assertThat(tags.get(AttributeConstants.DB_TYPE), is(getDatabaseType(DATA_SOURCE_NAME)));
+        assertThat(tags.get(AttributeConstants.DB_STATEMENT), is(SQL));
         assertThat(tags.get(AttributeConstants.SPAN_KIND), is(AttributeConstants.SPAN_KIND_CLIENT));
     }
     
@@ -94,9 +94,9 @@ public final class OpenTracingJDBCExecutorCallbackAdviceTest extends AbstractJDB
         Map<String, Object> tags = span.tags();
         assertThat(span.operationName(), is("/ShardingSphere/executeSQL/"));
         assertThat(tags.get(AttributeConstants.COMPONENT), is(AttributeConstants.COMPONENT_NAME));
-        assertThat(tags.get(AttributeConstants.DB_INSTANCE), is(getDataSourceName()));
-        assertThat(tags.get(AttributeConstants.DB_TYPE), is(getDatabaseType(getDataSourceName())));
-        assertThat(tags.get(AttributeConstants.DB_STATEMENT), is(getSql()));
+        assertThat(tags.get(AttributeConstants.DB_INSTANCE), is(DATA_SOURCE_NAME));
+        assertThat(tags.get(AttributeConstants.DB_TYPE), is(getDatabaseType(DATA_SOURCE_NAME)));
+        assertThat(tags.get(AttributeConstants.DB_STATEMENT), is(SQL));
         assertThat(tags.get(AttributeConstants.SPAN_KIND), is(AttributeConstants.SPAN_KIND_CLIENT));
     }
 }