From 3c8e5347f593095f22ea6990e7273e635be1f302 Mon Sep 17 00:00:00 2001 From: Oliver Date: Sun, 10 Apr 2022 20:17:02 +0800 Subject: [PATCH] Optimize document and fix typo (#148) --- .../log/logback/v1/x/TraceIdPatternLogbackLayout.java | 2 +- .../org/apache/skywalking/apm/toolkit/meter/Histogram.java | 2 +- .../org/apache/skywalking/apm/toolkit/meter/CounterTest.java | 3 ++- .../org/apache/skywalking/apm/toolkit/meter/GaugeTest.java | 3 ++- .../apache/skywalking/apm/toolkit/meter/HistogramTest.java | 5 +++-- .../apm/meter/micrometer/SkywalkingCounterTest.java | 2 +- .../meter/micrometer/SkywalkingDistributionSummaryTest.java | 2 +- .../apm/meter/micrometer/SkywalkingLongTaskTimerTest.java | 2 +- .../skywalking/apm/meter/micrometer/SkywalkingTimerTest.java | 2 +- .../skywalking/apm/toolkit/opentracing/SkywalkingSpan.java | 2 +- .../apm/commons/datacarrier/consumer/ConsumerThread.java | 2 +- .../skywalking/apm/agent/core/context/util/KeyValuePair.java | 2 +- .../apache/skywalking/apm/agent/core/meter/Histogram.java | 2 +- .../core/plugin/interceptor/enhance/ConstructorInter.java | 2 +- .../core/plugin/interceptor/enhance/InstMethodsInter.java | 2 +- .../enhance/InstMethodsInterWithOverrideArgs.java | 2 +- .../core/plugin/interceptor/enhance/StaticMethodsInter.java | 2 +- .../enhance/StaticMethodsInterWithOverrideArgs.java | 2 +- .../plugin/interceptor/enhance/v2/InstMethodsInterV2.java | 2 +- .../enhance/v2/InstMethodsInterV2WithOverrideArgs.java | 2 +- .../plugin/interceptor/enhance/v2/StaticMethodsInterV2.java | 2 +- .../enhance/v2/StaticMethodsInterV2WithOverrideArgs.java | 2 +- .../apache/skywalking/apm/agent/core/util/MethodUtil.java | 2 +- .../apm/dependencies/org/slf4j/impl/StaticLoggerBinder.java | 2 +- .../apm/plugin/asf/dubbo3/patch/WrapperInstrumentation.java | 4 ++-- .../apm/plugin/dubbo/patch/WrapperInstrumentation.java | 4 ++-- .../v4/define/HttpAsyncClientInstrumentation.java | 2 +- .../v4/define/SessionRequestInstrumentation.java | 2 +- .../v1/SWHystrixLifecycleForwardingRequestVariable.java | 2 +- docs/en/setup/service-agent/java-agent/configurations.md | 2 +- 30 files changed, 36 insertions(+), 33 deletions(-) diff --git a/apm-application-toolkit/apm-toolkit-logback-1.x/src/main/java/org/apache/skywalking/apm/toolkit/log/logback/v1/x/TraceIdPatternLogbackLayout.java b/apm-application-toolkit/apm-toolkit-logback-1.x/src/main/java/org/apache/skywalking/apm/toolkit/log/logback/v1/x/TraceIdPatternLogbackLayout.java index e49ce2e96..8a85b4dc4 100644 --- a/apm-application-toolkit/apm-toolkit-logback-1.x/src/main/java/org/apache/skywalking/apm/toolkit/log/logback/v1/x/TraceIdPatternLogbackLayout.java +++ b/apm-application-toolkit/apm-toolkit-logback-1.x/src/main/java/org/apache/skywalking/apm/toolkit/log/logback/v1/x/TraceIdPatternLogbackLayout.java @@ -21,7 +21,7 @@ package org.apache.skywalking.apm.toolkit.log.logback.v1.x; import ch.qos.logback.classic.PatternLayout; /** - * Based on the logback-compoenent convert register mechanism, register {@link LogbackPatternConverter} as a new + * Based on the logback-component convert register mechanism, register {@link LogbackPatternConverter} as a new * convert, match to "tid" and "sw_ctx". You can use "%tid" or "sw_ctx" in logback config file, "Pattern" section. *

*/ diff --git a/apm-application-toolkit/apm-toolkit-meter/src/main/java/org/apache/skywalking/apm/toolkit/meter/Histogram.java b/apm-application-toolkit/apm-toolkit-meter/src/main/java/org/apache/skywalking/apm/toolkit/meter/Histogram.java index 3915f2ba8..06659570e 100644 --- a/apm-application-toolkit/apm-toolkit-meter/src/main/java/org/apache/skywalking/apm/toolkit/meter/Histogram.java +++ b/apm-application-toolkit/apm-toolkit-meter/src/main/java/org/apache/skywalking/apm/toolkit/meter/Histogram.java @@ -54,7 +54,7 @@ public class Histogram extends BaseMeter { } /** - * Set bucket steps, the minimal values of every buckets besides the {@link #minValue}. + * Set bucket steps, the minimal values of every bucket besides the {@link #minValue}. */ public Builder steps(List steps) { this.steps = new ArrayList<>(steps); diff --git a/apm-application-toolkit/apm-toolkit-meter/src/test/java/org/apache/skywalking/apm/toolkit/meter/CounterTest.java b/apm-application-toolkit/apm-toolkit-meter/src/test/java/org/apache/skywalking/apm/toolkit/meter/CounterTest.java index 5e911e34f..1f9e0861f 100644 --- a/apm-application-toolkit/apm-toolkit-meter/src/test/java/org/apache/skywalking/apm/toolkit/meter/CounterTest.java +++ b/apm-application-toolkit/apm-toolkit-meter/src/test/java/org/apache/skywalking/apm/toolkit/meter/CounterTest.java @@ -18,13 +18,14 @@ package org.apache.skywalking.apm.toolkit.meter; +import org.junit.Assert; import org.junit.Test; public class CounterTest { @Test public void testBuild() { - MeterFactory.counter("test_counter").tag("k1", "v1").build(); + Assert.assertNotNull(MeterFactory.counter("test_counter").tag("k1", "v1").build()); } } diff --git a/apm-application-toolkit/apm-toolkit-meter/src/test/java/org/apache/skywalking/apm/toolkit/meter/GaugeTest.java b/apm-application-toolkit/apm-toolkit-meter/src/test/java/org/apache/skywalking/apm/toolkit/meter/GaugeTest.java index 1e0e4e609..b6c4eb262 100644 --- a/apm-application-toolkit/apm-toolkit-meter/src/test/java/org/apache/skywalking/apm/toolkit/meter/GaugeTest.java +++ b/apm-application-toolkit/apm-toolkit-meter/src/test/java/org/apache/skywalking/apm/toolkit/meter/GaugeTest.java @@ -18,13 +18,14 @@ package org.apache.skywalking.apm.toolkit.meter; +import org.junit.Assert; import org.junit.Test; public class GaugeTest { @Test public void testBuild() { - MeterFactory.gauge("test_gauge1", () -> 1d).tag("k1", "v1").build(); + Assert.assertNotNull(MeterFactory.gauge("test_gauge1", () -> 1d).tag("k1", "v1").build()); } } diff --git a/apm-application-toolkit/apm-toolkit-meter/src/test/java/org/apache/skywalking/apm/toolkit/meter/HistogramTest.java b/apm-application-toolkit/apm-toolkit-meter/src/test/java/org/apache/skywalking/apm/toolkit/meter/HistogramTest.java index 46c2c1eca..42d19e684 100644 --- a/apm-application-toolkit/apm-toolkit-meter/src/test/java/org/apache/skywalking/apm/toolkit/meter/HistogramTest.java +++ b/apm-application-toolkit/apm-toolkit-meter/src/test/java/org/apache/skywalking/apm/toolkit/meter/HistogramTest.java @@ -18,6 +18,7 @@ package org.apache.skywalking.apm.toolkit.meter; +import org.junit.Assert; import org.junit.Test; import java.util.Arrays; @@ -27,8 +28,8 @@ public class HistogramTest { @Test public void testBuild() { // normal - MeterFactory.histogram("test_histogram1").steps(Arrays.asList(1d, 5d, 10d)).minValue(-10) - .tag("k1", "v1").build(); + Assert.assertNotNull(MeterFactory.histogram("test_histogram1").steps(Arrays.asList(1d, 5d, 10d)).minValue(-10) + .tag("k1", "v1").build()); } } diff --git a/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingCounterTest.java b/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingCounterTest.java index e1cdaed7a..a0dbd1ee4 100644 --- a/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingCounterTest.java +++ b/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingCounterTest.java @@ -29,7 +29,7 @@ public class SkywalkingCounterTest { @Test public void testCounter() { - // Creating a simplify micrometer counter + // Creating a simplified micrometer counter final SkywalkingMeterRegistry registry = new SkywalkingMeterRegistry(); Counter counter = registry.counter("test_counter", "skywalking", "test"); diff --git a/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingDistributionSummaryTest.java b/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingDistributionSummaryTest.java index e87d7fea3..97fc1d1f6 100644 --- a/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingDistributionSummaryTest.java +++ b/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingDistributionSummaryTest.java @@ -30,7 +30,7 @@ public class SkywalkingDistributionSummaryTest { @Test public void testSimple() { - // Creating a simplify distribution summary + // Creating a simplified distribution summary final SkywalkingMeterRegistry registry = new SkywalkingMeterRegistry(); final DistributionSummary summary = registry.summary("test_simple_distribution_summary", "skywalking", "test"); diff --git a/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingLongTaskTimerTest.java b/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingLongTaskTimerTest.java index 5b1633256..686f57c99 100644 --- a/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingLongTaskTimerTest.java +++ b/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingLongTaskTimerTest.java @@ -28,7 +28,7 @@ public class SkywalkingLongTaskTimerTest { @Test public void testSimple() throws InterruptedException { - // Creating a simplify long task timer + // Creating a simplified long task timer final SkywalkingMeterRegistry registry = new SkywalkingMeterRegistry(); final LongTaskTimer longTaskTimer = registry.more().longTaskTimer("test_simple_long_task_timer", "skywalking", "test"); diff --git a/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingTimerTest.java b/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingTimerTest.java index a971decba..aec382e98 100644 --- a/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingTimerTest.java +++ b/apm-application-toolkit/apm-toolkit-micrometer-registry/src/test/java/org/apache/skywalking/apm/meter/micrometer/SkywalkingTimerTest.java @@ -32,7 +32,7 @@ public class SkywalkingTimerTest { @Test public void testSimpleTimer() { - // Creating a simplify timer + // Creating a simplified timer final SkywalkingMeterRegistry registry = new SkywalkingMeterRegistry(); final Timer timer = registry.timer("test_simple_timer", "skywalking", "test"); diff --git a/apm-application-toolkit/apm-toolkit-opentracing/src/main/java/org/apache/skywalking/apm/toolkit/opentracing/SkywalkingSpan.java b/apm-application-toolkit/apm-toolkit-opentracing/src/main/java/org/apache/skywalking/apm/toolkit/opentracing/SkywalkingSpan.java index c6d833b9a..b43efc9a4 100644 --- a/apm-application-toolkit/apm-toolkit-opentracing/src/main/java/org/apache/skywalking/apm/toolkit/opentracing/SkywalkingSpan.java +++ b/apm-application-toolkit/apm-toolkit-opentracing/src/main/java/org/apache/skywalking/apm/toolkit/opentracing/SkywalkingSpan.java @@ -51,7 +51,7 @@ public class SkywalkingSpan implements Span { /** * Stop the active span */ - @NeedSnifferActivation("1.ContextManager#stopSpan(AbstractSpan span)" + "2. The parameter of stop methed is from the dynamic field of enhanced SkywalkingSpan") + @NeedSnifferActivation("1.ContextManager#stopSpan(AbstractSpan span)" + "2. The parameter of stop method is from the dynamic field of enhanced SkywalkingSpan") @Override public void finish(long finishMicros) { diff --git a/apm-commons/apm-datacarrier/src/main/java/org/apache/skywalking/apm/commons/datacarrier/consumer/ConsumerThread.java b/apm-commons/apm-datacarrier/src/main/java/org/apache/skywalking/apm/commons/datacarrier/consumer/ConsumerThread.java index 122f37eb5..6c8d5ed80 100644 --- a/apm-commons/apm-datacarrier/src/main/java/org/apache/skywalking/apm/commons/datacarrier/consumer/ConsumerThread.java +++ b/apm-commons/apm-datacarrier/src/main/java/org/apache/skywalking/apm/commons/datacarrier/consumer/ConsumerThread.java @@ -89,7 +89,7 @@ public class ConsumerThread extends Thread { } /** - * DataSource is a refer to {@link Buffer}. + * DataSource is a reference to {@link Buffer}. */ class DataSource { private QueueBuffer sourceBuffer; diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/context/util/KeyValuePair.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/context/util/KeyValuePair.java index 3db0ec62b..6cec4b47c 100644 --- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/context/util/KeyValuePair.java +++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/context/util/KeyValuePair.java @@ -21,7 +21,7 @@ package org.apache.skywalking.apm.agent.core.context.util; import org.apache.skywalking.apm.network.common.v3.KeyStringValuePair; /** - * The KeyValuePair represents a object which contains a string key and a string value. + * The KeyValuePair represents an object which contains a string key and a string value. */ public class KeyValuePair { private String key; diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/Histogram.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/Histogram.java index 8944a9d79..fe61bc9c4 100644 --- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/Histogram.java +++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/meter/Histogram.java @@ -111,7 +111,7 @@ public class Histogram extends BaseMeter { } /** - * Set bucket steps, the minimal values of every buckets besides the {@link #minValue}. + * Set bucket steps, the minimal values of every bucket besides the {@link #minValue}. */ public Builder steps(List steps) { this.steps = new ArrayList<>(steps); diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/ConstructorInter.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/ConstructorInter.java index 08c928fb3..8a057df25 100644 --- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/ConstructorInter.java +++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/ConstructorInter.java @@ -27,7 +27,7 @@ import org.apache.skywalking.apm.agent.core.plugin.loader.InterceptorInstanceLoa import org.apache.skywalking.apm.agent.core.logging.api.ILog; /** - * The actual byte-buddy's interceptor to intercept constructor methods. In this class, it provide a bridge between + * The actual byte-buddy's interceptor to intercept constructor methods. In this class, it provides a bridge between * byte-buddy and sky-walking plugin. */ public class ConstructorInter { diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/InstMethodsInter.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/InstMethodsInter.java index 58f18398c..81ebfb1b7 100644 --- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/InstMethodsInter.java +++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/InstMethodsInter.java @@ -31,7 +31,7 @@ import org.apache.skywalking.apm.agent.core.plugin.loader.InterceptorInstanceLoa import org.apache.skywalking.apm.agent.core.logging.api.ILog; /** - * The actual byte-buddy's interceptor to intercept class instance methods. In this class, it provide a bridge between + * The actual byte-buddy's interceptor to intercept class instance methods. In this class, it provides a bridge between * byte-buddy and sky-walking plugin. */ public class InstMethodsInter { diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/InstMethodsInterWithOverrideArgs.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/InstMethodsInterWithOverrideArgs.java index f0cbfc5e0..1bba49c17 100644 --- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/InstMethodsInterWithOverrideArgs.java +++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/InstMethodsInterWithOverrideArgs.java @@ -30,7 +30,7 @@ import org.apache.skywalking.apm.agent.core.logging.api.ILog; import org.apache.skywalking.apm.agent.core.logging.api.LogManager; /** - * The actual byte-buddy's interceptor to intercept class instance methods. In this class, it provide a bridge between + * The actual byte-buddy's interceptor to intercept class instance methods. In this class, it provides a bridge between * byte-buddy and sky-walking plugin. */ public class InstMethodsInterWithOverrideArgs { diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/StaticMethodsInter.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/StaticMethodsInter.java index c6fcc2ac0..6507118aa 100644 --- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/StaticMethodsInter.java +++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/StaticMethodsInter.java @@ -29,7 +29,7 @@ import org.apache.skywalking.apm.agent.core.logging.api.ILog; import org.apache.skywalking.apm.agent.core.logging.api.LogManager; /** - * The actual byte-buddy's interceptor to intercept class static methods. In this class, it provide a bridge between + * The actual byte-buddy's interceptor to intercept class static methods. In this class, it provides a bridge between * byte-buddy and sky-walking plugin. */ public class StaticMethodsInter { diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/StaticMethodsInterWithOverrideArgs.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/StaticMethodsInterWithOverrideArgs.java index fe394b9e3..83e66e4bc 100644 --- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/StaticMethodsInterWithOverrideArgs.java +++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/StaticMethodsInterWithOverrideArgs.java @@ -28,7 +28,7 @@ import org.apache.skywalking.apm.agent.core.logging.api.ILog; import org.apache.skywalking.apm.agent.core.logging.api.LogManager; /** - * The actual byte-buddy's interceptor to intercept class static methods. In this class, it provide a bridge between + * The actual byte-buddy's interceptor to intercept class static methods. In this class, it provides a bridge between * byte-buddy and sky-walking plugin. */ public class StaticMethodsInterWithOverrideArgs { diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/InstMethodsInterV2.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/InstMethodsInterV2.java index 4afd93cdc..863898093 100644 --- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/InstMethodsInterV2.java +++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/InstMethodsInterV2.java @@ -31,7 +31,7 @@ import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedI import org.apache.skywalking.apm.agent.core.plugin.loader.InterceptorInstanceLoader; /** - * The actual byte-buddy's interceptor to intercept class instance methods. In this class, it provide a bridge between + * The actual byte-buddy's interceptor to intercept class instance methods. In this class, it provides a bridge between * byte-buddy and sky-walking plugin. */ public class InstMethodsInterV2 { diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/InstMethodsInterV2WithOverrideArgs.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/InstMethodsInterV2WithOverrideArgs.java index 72b1311e4..5779a386f 100644 --- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/InstMethodsInterV2WithOverrideArgs.java +++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/InstMethodsInterV2WithOverrideArgs.java @@ -32,7 +32,7 @@ import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.OverrideC import org.apache.skywalking.apm.agent.core.plugin.loader.InterceptorInstanceLoader; /** - * The actual byte-buddy's interceptor to intercept class instance methods. In this class, it provide a bridge between + * The actual byte-buddy's interceptor to intercept class instance methods. In this class, it provides a bridge between * byte-buddy and sky-walking plugin. */ public class InstMethodsInterV2WithOverrideArgs { diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/StaticMethodsInterV2.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/StaticMethodsInterV2.java index 641e8edba..677ffa369 100644 --- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/StaticMethodsInterV2.java +++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/StaticMethodsInterV2.java @@ -29,7 +29,7 @@ import org.apache.skywalking.apm.agent.core.logging.api.LogManager; import org.apache.skywalking.apm.agent.core.plugin.loader.InterceptorInstanceLoader; /** - * The actual byte-buddy's interceptor to intercept class instance methods. In this class, it provide a bridge between + * The actual byte-buddy's interceptor to intercept class instance methods. In this class, it provides a bridge between * byte-buddy and sky-walking plugin. */ public class StaticMethodsInterV2 { diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/StaticMethodsInterV2WithOverrideArgs.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/StaticMethodsInterV2WithOverrideArgs.java index 8e5cb15bc..e7d326b43 100644 --- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/StaticMethodsInterV2WithOverrideArgs.java +++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/plugin/interceptor/enhance/v2/StaticMethodsInterV2WithOverrideArgs.java @@ -29,7 +29,7 @@ import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.OverrideC import org.apache.skywalking.apm.agent.core.plugin.loader.InterceptorInstanceLoader; /** - * The actual byte-buddy's interceptor to intercept class instance methods. In this class, it provide a bridge between + * The actual byte-buddy's interceptor to intercept class instance methods. In this class, it provides a bridge between * byte-buddy and sky-walking plugin. */ public class StaticMethodsInterV2WithOverrideArgs { diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/util/MethodUtil.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/util/MethodUtil.java index 0d9a254f6..0ba204b33 100644 --- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/util/MethodUtil.java +++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/util/MethodUtil.java @@ -41,7 +41,7 @@ public class MethodUtil { } /** - * This is a low-performance method, recommand to use this when have to, make sure it is only executed once and the + * This is a low-performance method, recommend to use this when have to, make sure it is only executed once and the * result is being cached. */ public static boolean isMethodExist(ClassLoader classLoader, String className, String methodName, diff --git a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/dependencies/org/slf4j/impl/StaticLoggerBinder.java b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/dependencies/org/slf4j/impl/StaticLoggerBinder.java index 92551d272..3f43023c4 100644 --- a/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/dependencies/org/slf4j/impl/StaticLoggerBinder.java +++ b/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/dependencies/org/slf4j/impl/StaticLoggerBinder.java @@ -51,7 +51,7 @@ public final class StaticLoggerBinder implements LoggerFactoryBinder { /** * Returns the singleton of this class. - * Dot't delete this method, this method will called by {@link org.slf4j.LoggerFactory#bind()} + * Don't delete this method, this method will called by {@link org.slf4j.LoggerFactory#bind()} * * @return the StaticLoggerBinder singleton */ diff --git a/apm-sniffer/apm-sdk-plugin/dubbo-3.x-conflict-patch/src/main/java/org/apache/skywalking/apm/plugin/asf/dubbo3/patch/WrapperInstrumentation.java b/apm-sniffer/apm-sdk-plugin/dubbo-3.x-conflict-patch/src/main/java/org/apache/skywalking/apm/plugin/asf/dubbo3/patch/WrapperInstrumentation.java index 882d7a1ae..2dd038c87 100644 --- a/apm-sniffer/apm-sdk-plugin/dubbo-3.x-conflict-patch/src/main/java/org/apache/skywalking/apm/plugin/asf/dubbo3/patch/WrapperInstrumentation.java +++ b/apm-sniffer/apm-sdk-plugin/dubbo-3.x-conflict-patch/src/main/java/org/apache/skywalking/apm/plugin/asf/dubbo3/patch/WrapperInstrumentation.java @@ -33,8 +33,8 @@ import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName /** * The dubbo conflict plugin resolver the problem about the wrapper class generated by Dubbo core cannot be compiled - * successfully. As we known, The wrapper class traverses all the methods. In usual, it works unless this class has been - * enhanced by Skywalking. The javasist cannot found the `EnhanceInstance` method when generate. + * successfully. As we have known, The wrapper class traverses all the methods. In usual, it works unless this class has been + * enhanced by Skywalking. The javasist cannot found the `EnhanceInstance` method when generated. *

* The plugin excludes {@link org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance} methods * to ensure the correct compilation of the code. diff --git a/apm-sniffer/apm-sdk-plugin/dubbo-conflict-patch/src/main/java/org/apache/skywalking/apm/plugin/dubbo/patch/WrapperInstrumentation.java b/apm-sniffer/apm-sdk-plugin/dubbo-conflict-patch/src/main/java/org/apache/skywalking/apm/plugin/dubbo/patch/WrapperInstrumentation.java index 1b0d49ff6..dfc2ed674 100644 --- a/apm-sniffer/apm-sdk-plugin/dubbo-conflict-patch/src/main/java/org/apache/skywalking/apm/plugin/dubbo/patch/WrapperInstrumentation.java +++ b/apm-sniffer/apm-sdk-plugin/dubbo-conflict-patch/src/main/java/org/apache/skywalking/apm/plugin/dubbo/patch/WrapperInstrumentation.java @@ -28,8 +28,8 @@ import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName /** * The dubbo conflict plugin resolver the problem about the wrapper class generated by Dubbo core cannot be compiled - * successfully. As we known, The wrapper class traverses all the methods. In usual, it works unless this class has been - * enhanced by Skywalking. The javasist cannot found the `EnhanceInstance` method when generate. + * successfully. As we have known, The wrapper class traverses all the methods. In usual, it works unless this class has been + * enhanced by Skywalking. The javasist cannot found the `EnhanceInstance` method when generated. *

* The plugin excludes {@link org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance} methods * to ensure the correct compilation of the code. diff --git a/apm-sniffer/apm-sdk-plugin/httpasyncclient-4.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/httpasyncclient/v4/define/HttpAsyncClientInstrumentation.java b/apm-sniffer/apm-sdk-plugin/httpasyncclient-4.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/httpasyncclient/v4/define/HttpAsyncClientInstrumentation.java index 744ce0eff..c42707b90 100644 --- a/apm-sniffer/apm-sdk-plugin/httpasyncclient-4.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/httpasyncclient/v4/define/HttpAsyncClientInstrumentation.java +++ b/apm-sniffer/apm-sdk-plugin/httpasyncclient-4.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/httpasyncclient/v4/define/HttpAsyncClientInstrumentation.java @@ -34,7 +34,7 @@ import static net.bytebuddy.matcher.ElementMatchers.takesArguments; * org.apache.http.impl.nio.client.MinimalHttpAsyncClient#execute(HttpAsyncRequestProducer, HttpAsyncResponseConsumer, * HttpContext, FutureCallback) and InternalHttpAsyncClient#execute(HttpAsyncRequestProducer, HttpAsyncResponseConsumer, * HttpContext, FutureCallback) can be instrumented for single request.pipeline is not support now for some complex - * situation.this is run in main thread. + * situation. This is run in main thread. */ public class HttpAsyncClientInstrumentation extends ClassInstanceMethodsEnhancePluginDefine { diff --git a/apm-sniffer/apm-sdk-plugin/httpasyncclient-4.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/httpasyncclient/v4/define/SessionRequestInstrumentation.java b/apm-sniffer/apm-sdk-plugin/httpasyncclient-4.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/httpasyncclient/v4/define/SessionRequestInstrumentation.java index a70d312c1..a66252c29 100644 --- a/apm-sniffer/apm-sdk-plugin/httpasyncclient-4.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/httpasyncclient/v4/define/SessionRequestInstrumentation.java +++ b/apm-sniffer/apm-sdk-plugin/httpasyncclient-4.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/httpasyncclient/v4/define/SessionRequestInstrumentation.java @@ -30,7 +30,7 @@ import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName /** * this is a bridge for main thread and real request thread which mean hold the {@link - * org.apache.skywalking.apm.agent.core.context.ContextSnapshot} object to be continued in "completed" method.that is + * org.apache.skywalking.apm.agent.core.context.ContextSnapshot} object to be continued in "completed" method. That is * mean the request is ready to submit */ public class SessionRequestInstrumentation extends ClassInstanceMethodsEnhancePluginDefine { diff --git a/apm-sniffer/apm-sdk-plugin/hystrix-1.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/hystrix/v1/SWHystrixLifecycleForwardingRequestVariable.java b/apm-sniffer/apm-sdk-plugin/hystrix-1.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/hystrix/v1/SWHystrixLifecycleForwardingRequestVariable.java index 1e6f01cb7..053a2bf1c 100644 --- a/apm-sniffer/apm-sdk-plugin/hystrix-1.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/hystrix/v1/SWHystrixLifecycleForwardingRequestVariable.java +++ b/apm-sniffer/apm-sdk-plugin/hystrix-1.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/hystrix/v1/SWHystrixLifecycleForwardingRequestVariable.java @@ -31,7 +31,7 @@ import com.netflix.hystrix.strategy.concurrency.HystrixConcurrencyStrategy; *

* This implementation also returns null when {@link #get()} is called while the {@link HystrixRequestContext} has not * been initialized rather than throwing an exception, allowing for use in a {@link HystrixConcurrencyStrategy} which - * does not depend on an a HystrixRequestContext + * does not depend on an HystrixRequestContext */ public class SWHystrixLifecycleForwardingRequestVariable extends HystrixRequestVariableDefault { private final HystrixRequestVariableLifecycle lifecycle; diff --git a/docs/en/setup/service-agent/java-agent/configurations.md b/docs/en/setup/service-agent/java-agent/configurations.md index e85614ff1..a9b27f516 100644 --- a/docs/en/setup/service-agent/java-agent/configurations.md +++ b/docs/en/setup/service-agent/java-agent/configurations.md @@ -60,7 +60,7 @@ This is the properties list supported in `agent/config/agent.config`. | `log.max_message_size` | The max size of message to send to server.Default is 10 MB. | SW_GRPC_LOG_MAX_MESSAGE_SIZE | `10485760` | | `plugin.mount` | Mount the specific folders of the plugins. Plugins in mounted folders would work. | SW_MOUNT_FOLDERS | `plugins,activations` | | `plugin.peer_max_length ` | Peer maximum description limit. | SW_PLUGIN_PEER_MAX_LENGTH | `200` | -| `plugin.exclude_plugins ` | Exclude some plugins define in plugins dir.Plugin names is defined in [Agent plugin list](Plugin-list.md) | SW_EXCLUDE_PLUGINS | `""` | +| `plugin.exclude_plugins ` | Exclude some plugins define in plugins dir,Multiple plugins are separated by comma.Plugin names is defined in [Agent plugin list](Plugin-list.md) | SW_EXCLUDE_PLUGINS | `""` | | `plugin.mongodb.trace_param` | If true, trace all the parameters in MongoDB access, default is false. Only trace the operation, not include parameters. | SW_PLUGIN_MONGODB_TRACE_PARAM | `false` | | `plugin.mongodb.filter_length_limit` | If set to positive number, the `WriteRequest.params` would be truncated to this length, otherwise it would be completely saved, which may cause performance problem. | SW_PLUGIN_MONGODB_FILTER_LENGTH_LIMIT | `256` | | `plugin.elasticsearch.trace_dsl` | If true, trace all the DSL(Domain Specific Language) in ElasticSearch access, default is false. | SW_PLUGIN_ELASTICSEARCH_TRACE_DSL | `false` |