[skywalking] branch master updated: Fix typo and add comments. (#5495)

[wu...@apache.org]

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

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


The following commit(s) were added to refs/heads/master by this push:
     new 54ee2e6  Fix typo and add comments. (#5495)
54ee2e6 is described below

commit 54ee2e61add7c1c3af5afa2b684d24521eb6f384
Author: 吴晟 Wu Sheng <wu...@foxmail.com>
AuthorDate: Wed Sep 16 11:27:38 2020 +0800

    Fix typo and add comments. (#5495)
    
    * Fix typo and add comments.
    
    * Fix comment.
---
 .../org/apache/skywalking/apm/agent/core/meter/MeterSender.java   | 4 +++-
 .../org/apache/skywalking/apm/agent/core/meter/MeterService.java  | 3 +++
 .../skywalking/apm/agent/core/meter/adapter/MeterAdapter.java     | 3 +++
 .../apm/toolkit/activation/meter/CounterInterceptor.java          | 4 ++--
 .../{TookitCounterAdapter.java => ToolkitCounterAdapter.java}     | 4 ++--
 .../skywalking/apm/toolkit/meter/ToolkitCounterAdapterTest.java   | 8 ++++----
 .../apache/skywalking/apm/agent/core/kafka/KafkaMeterSender.java  | 2 +-
 .../skywalking/oap/server/telemetry/prometheus/BaseMetrics.java   | 8 +++++++-
 8 files changed, 25 insertions(+), 11 deletions(-)

diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/MeterSender.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/MeterSender.java
index 2c2d3b3..d974d31 100644
--- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/MeterSender.java
+++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/MeterSender.java
@@ -42,12 +42,14 @@ import org.apache.skywalking.apm.network.language.agent.v3.MeterReportServiceGrp
 
 import static org.apache.skywalking.apm.agent.core.conf.Config.Collector.GRPC_UPSTREAM_TIMEOUT;
 
+/**
+ * Collect the values from given registered metrics, and send to the backend.
+ */
 @DefaultImplementor
 public class MeterSender implements BootService, GRPCChannelListener {
     private static final ILog LOGGER = LogManager.getLogger(MeterSender.class);
 
     private volatile GRPCChannelStatus status = GRPCChannelStatus.DISCONNECT;
-
     private volatile MeterReportServiceGrpc.MeterReportServiceStub meterReportServiceStub;
 
     @Override
diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/MeterService.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/MeterService.java
index 57e1193..e5fb4e6 100644
--- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/MeterService.java
+++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/MeterService.java
@@ -32,6 +32,9 @@ import org.apache.skywalking.apm.agent.core.logging.api.LogManager;
 import org.apache.skywalking.apm.agent.core.meter.transform.MeterTransformer;
 import org.apache.skywalking.apm.util.RunnableWithExceptionProtection;
 
+/**
+ * Agent core level service. It provides the register map for all available metrics and send them through meter sender.
+ */
 @DefaultImplementor
 public class MeterService implements BootService, Runnable {
     private static final ILog LOGGER = LogManager.getLogger(MeterService.class);
diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/adapter/MeterAdapter.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/adapter/MeterAdapter.java
index 5985ff3..c3eedfe 100644
--- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/adapter/MeterAdapter.java
+++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/adapter/MeterAdapter.java
@@ -24,5 +24,8 @@ import org.apache.skywalking.apm.agent.core.meter.MeterId;
  * Working on adapt the tool-kit side with agent core
  */
 public interface MeterAdapter {
+    /**
+     * @return {@link MeterId}
+     */
     MeterId getId();
 }
diff --git a/apm-sniffer/apm-toolkit-activation/apm-toolkit-meter-activation/src/main/java/org/apache/skywalking/apm/toolkit/activation/meter/CounterInterceptor.java b/apm-sniffer/apm-toolkit-activation/apm-toolkit-meter-activation/src/main/java/org/apache/skywalking/apm/toolkit/activation/meter/CounterInterceptor.java
index de2fba4..cbd5816 100644
--- a/apm-sniffer/apm-toolkit-activation/apm-toolkit-meter-activation/src/main/java/org/apache/skywalking/apm/toolkit/activation/meter/CounterInterceptor.java
+++ b/apm-sniffer/apm-toolkit-activation/apm-toolkit-meter-activation/src/main/java/org/apache/skywalking/apm/toolkit/activation/meter/CounterInterceptor.java
@@ -24,7 +24,7 @@ import org.apache.skywalking.apm.agent.core.meter.MeterService;
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance;
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.InstanceConstructorInterceptor;
 import org.apache.skywalking.apm.toolkit.meter.impl.CounterImpl;
-import org.apache.skywalking.apm.toolkit.activation.meter.adapter.TookitCounterAdapter;
+import org.apache.skywalking.apm.toolkit.activation.meter.adapter.ToolkitCounterAdapter;
 
 public class CounterInterceptor implements InstanceConstructorInterceptor {
     private static MeterService METER_SERVICE;
@@ -33,7 +33,7 @@ public class CounterInterceptor implements InstanceConstructorInterceptor {
     public void onConstruct(EnhancedInstance objInst, Object[] allArguments) {
         final CounterImpl toolkitCounter = (CounterImpl) objInst;
 
-        final TookitCounterAdapter counterAdapter = new TookitCounterAdapter(toolkitCounter);
+        final ToolkitCounterAdapter counterAdapter = new ToolkitCounterAdapter(toolkitCounter);
         final CounterTransformer counterTransformer = new CounterTransformer(counterAdapter);
 
         if (METER_SERVICE == null) {
diff --git a/apm-sniffer/apm-toolkit-activation/apm-toolkit-meter-activation/src/main/java/org/apache/skywalking/apm/toolkit/activation/meter/adapter/TookitCounterAdapter.java b/apm-sniffer/apm-toolkit-activation/apm-toolkit-meter-activation/src/main/java/org/apache/skywalking/apm/toolkit/activation/meter/adapter/ToolkitCounterAdapter.java
similarity index 92%
rename from apm-sniffer/apm-toolkit-activation/apm-toolkit-meter-activation/src/main/java/org/apache/skywalking/apm/toolkit/activation/meter/adapter/TookitCounterAdapter.java
rename to apm-sniffer/apm-toolkit-activation/apm-toolkit-meter-activation/src/main/java/org/apache/skywalking/apm/toolkit/activation/meter/adapter/ToolkitCounterAdapter.java
index d40ff2a..26337aa 100644
--- a/apm-sniffer/apm-toolkit-activation/apm-toolkit-meter-activation/src/main/java/org/apache/skywalking/apm/toolkit/activation/meter/adapter/TookitCounterAdapter.java
+++ b/apm-sniffer/apm-toolkit-activation/apm-toolkit-meter-activation/src/main/java/org/apache/skywalking/apm/toolkit/activation/meter/adapter/ToolkitCounterAdapter.java
@@ -23,12 +23,12 @@ import org.apache.skywalking.apm.agent.core.meter.adapter.CounterAdapter;
 import org.apache.skywalking.apm.toolkit.activation.meter.util.MeterIdConverter;
 import org.apache.skywalking.apm.toolkit.meter.impl.CounterImpl;
 
-public class TookitCounterAdapter implements CounterAdapter {
+public class ToolkitCounterAdapter implements CounterAdapter {
 
     private final CounterImpl counter;
     private final MeterId id;
 
-    public TookitCounterAdapter(CounterImpl counter) {
+    public ToolkitCounterAdapter(CounterImpl counter) {
         this.counter = counter;
         this.id = MeterIdConverter.convert(counter.getMeterId());
     }
diff --git a/apm-sniffer/apm-toolkit-activation/apm-toolkit-meter-activation/src/test/java/org/apache/skywalking/apm/toolkit/meter/ToolkitCounterAdapterTest.java b/apm-sniffer/apm-toolkit-activation/apm-toolkit-meter-activation/src/test/java/org/apache/skywalking/apm/toolkit/meter/ToolkitCounterAdapterTest.java
index 32ad6dd..5480fa4 100644
--- a/apm-sniffer/apm-toolkit-activation/apm-toolkit-meter-activation/src/test/java/org/apache/skywalking/apm/toolkit/meter/ToolkitCounterAdapterTest.java
+++ b/apm-sniffer/apm-toolkit-activation/apm-toolkit-meter-activation/src/test/java/org/apache/skywalking/apm/toolkit/meter/ToolkitCounterAdapterTest.java
@@ -21,7 +21,7 @@ package org.apache.skywalking.apm.toolkit.meter;
 import org.apache.skywalking.apm.agent.core.meter.MeterId;
 import org.apache.skywalking.apm.agent.core.meter.MeterTag;
 import org.apache.skywalking.apm.agent.core.meter.MeterType;
-import org.apache.skywalking.apm.toolkit.activation.meter.adapter.TookitCounterAdapter;
+import org.apache.skywalking.apm.toolkit.activation.meter.adapter.ToolkitCounterAdapter;
 import org.apache.skywalking.apm.toolkit.meter.impl.CounterImpl;
 import org.junit.Assert;
 import org.junit.Test;
@@ -31,7 +31,7 @@ public class ToolkitCounterAdapterTest {
     @Test
     public void testGetCount() {
         final Counter counter = MeterFactory.counter("test").build();
-        final TookitCounterAdapter adapter = new TookitCounterAdapter((CounterImpl) counter);
+        final ToolkitCounterAdapter adapter = new ToolkitCounterAdapter((CounterImpl) counter);
 
         counter.increment(1d);
         counter.increment(2d);
@@ -45,7 +45,7 @@ public class ToolkitCounterAdapterTest {
     @Test
     public void testGetCountWithRate() {
         final Counter counter = MeterFactory.counter("test_with_rate").mode(Counter.Mode.RATE).build();
-        final TookitCounterAdapter adapter = new TookitCounterAdapter((CounterImpl) counter);
+        final ToolkitCounterAdapter adapter = new ToolkitCounterAdapter((CounterImpl) counter);
 
         counter.increment(1d);
         counter.increment(2d);
@@ -60,7 +60,7 @@ public class ToolkitCounterAdapterTest {
     @Test
     public void testGetId() {
         final Counter counter = MeterFactory.counter("test").tag("k1", "v1").build();
-        final TookitCounterAdapter adapter = new TookitCounterAdapter((CounterImpl) counter);
+        final ToolkitCounterAdapter adapter = new ToolkitCounterAdapter((CounterImpl) counter);
 
         final MeterId id = adapter.getId();
         Assert.assertEquals("test", id.getName());
diff --git a/apm-sniffer/optional-reporter-plugins/kafka-reporter-plugin/src/main/java/org/apache/skywalking/apm/agent/core/kafka/KafkaMeterSender.java b/apm-sniffer/optional-reporter-plugins/kafka-reporter-plugin/src/main/java/org/apache/skywalking/apm/agent/core/kafka/KafkaMeterSender.java
index f20d9c4..30aa901 100644
--- a/apm-sniffer/optional-reporter-plugins/kafka-reporter-plugin/src/main/java/org/apache/skywalking/apm/agent/core/kafka/KafkaMeterSender.java
+++ b/apm-sniffer/optional-reporter-plugins/kafka-reporter-plugin/src/main/java/org/apache/skywalking/apm/agent/core/kafka/KafkaMeterSender.java
@@ -34,7 +34,7 @@ import org.apache.skywalking.apm.agent.core.meter.transform.MeterTransformer;
 import org.apache.skywalking.apm.network.language.agent.v3.MeterDataCollection;
 
 /**
- * A report to send JVM Metrics data to Kafka Broker.
+ * A report to send Metrics data of meter system to Kafka Broker.
  */
 @OverrideImplementor(MeterSender.class)
 public class KafkaMeterSender extends MeterSender {
diff --git a/oap-server/server-telemetry/telemetry-prometheus/src/main/java/org/apache/skywalking/oap/server/telemetry/prometheus/BaseMetrics.java b/oap-server/server-telemetry/telemetry-prometheus/src/main/java/org/apache/skywalking/oap/server/telemetry/prometheus/BaseMetrics.java
index cac8084..57f5a14 100644
--- a/oap-server/server-telemetry/telemetry-prometheus/src/main/java/org/apache/skywalking/oap/server/telemetry/prometheus/BaseMetrics.java
+++ b/oap-server/server-telemetry/telemetry-prometheus/src/main/java/org/apache/skywalking/oap/server/telemetry/prometheus/BaseMetrics.java
@@ -26,7 +26,7 @@ import org.apache.skywalking.oap.server.telemetry.api.MetricsTag;
 import org.apache.skywalking.oap.server.telemetry.api.TelemetryRelatedContext;
 
 /**
- * BaseMetrics parent class represents the me
+ * BaseMetrics parent class represents the metrics
  */
 public abstract class BaseMetrics<T extends SimpleCollector, C> {
     private static Map<String, Object> ALL_METRICS = new HashMap<>();
@@ -49,6 +49,12 @@ public abstract class BaseMetrics<T extends SimpleCollector, C> {
         return TelemetryRelatedContext.INSTANCE.getId() != null;
     }
 
+    /**
+     * Create real prometheus metrics with SkyWalking native labels, and provide to all metrics implementation. Metrics
+     * name should be unique.
+     *
+     * @return metric reference if the service instance id has been initialized. Or NULL.
+     */
     protected C getMetric() {
         if (metricsInstance == null) {
             if (isIDReady()) {