From ff1103ec1d2d7c6a1a896730cfe3024e1e99782f Mon Sep 17 00:00:00 2001 From: Kai Date: Wed, 2 Mar 2022 22:05:02 +0800 Subject: [PATCH] Unify module name `receiver_zipkin` to `receiver-zipkin`, remove `receiver_jaeger` from `application.yaml`. (#8616) --- CHANGES.md | 1 + docs/en/setup/backend/configuration-vocabulary.md | 2 +- docs/en/setup/backend/zipkin-trace.md | 2 +- .../oap/server/receiver/zipkin/ZipkinReceiverModule.java | 2 +- .../server-starter/src/main/resources/application.yml | 8 +------- .../starter/config/ApplicationConfigLoaderTestCase.java | 6 +++--- 6 files changed, 8 insertions(+), 13 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index c4fd19bb39..212d0d99e1 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -77,6 +77,7 @@ Release Notes. * Disable indexing for field `alarm_record.tags_raw_data` of binary type in ElasticSearch storage. * Fix Zipkin receiver wrong condition for decoding `gzip`. * Add a new sampler (`possibility`) in LAL. +* Unify module name `receiver_zipkin` to `receiver-zipkin`, remove `receiver_jaeger` from `application.yaml`. #### UI diff --git a/docs/en/setup/backend/configuration-vocabulary.md b/docs/en/setup/backend/configuration-vocabulary.md index d6ee0942a5..6b39677f4b 100644 --- a/docs/en/setup/backend/configuration-vocabulary.md +++ b/docs/en/setup/backend/configuration-vocabulary.md @@ -200,7 +200,7 @@ core|default|role|Option values: `Mixed/Receiver/Aggregator`. **Receiver** mode | receiver-otel | default | A receiver for analyzing metrics data from OpenTelemetry. | - | - | | - | - | enabledHandlers| Enabled handlers for otel. | SW_OTEL_RECEIVER_ENABLED_HANDLERS | - | | - | - | enabledOcRules| Enabled metric rules for OC handler. | SW_OTEL_RECEIVER_ENABLED_OC_RULES | - | -| receiver_zipkin |default| A receiver for Zipkin traces. | - | - | +| receiver-zipkin |default| A receiver for Zipkin traces. | - | - | | - | - | restHost| Binding IP of RESTful services. |SW_RECEIVER_ZIPKIN_HOST|0.0.0.0| | - | - | restPort | Binding port of RESTful services. | SW_RECEIVER_ZIPKIN_PORT|9411| | - | - | restContextPath| Web context path of RESTful services. | SW_RECEIVER_ZIPKIN_CONTEXT_PATH|/| diff --git a/docs/en/setup/backend/zipkin-trace.md b/docs/en/setup/backend/zipkin-trace.md index 9f465cec20..35f6c9c769 100644 --- a/docs/en/setup/backend/zipkin-trace.md +++ b/docs/en/setup/backend/zipkin-trace.md @@ -6,7 +6,7 @@ dependency from Zipkin's trace. Use the following config to activate it. ```yaml -receiver_zipkin: +receiver-zipkin: selector: ${SW_RECEIVER_ZIPKIN:-} default: host: ${SW_RECEIVER_ZIPKIN_HOST:0.0.0.0} diff --git a/oap-server/server-receiver-plugin/zipkin-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/zipkin/ZipkinReceiverModule.java b/oap-server/server-receiver-plugin/zipkin-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/zipkin/ZipkinReceiverModule.java index 69c0e311e0..0e0d951255 100644 --- a/oap-server/server-receiver-plugin/zipkin-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/zipkin/ZipkinReceiverModule.java +++ b/oap-server/server-receiver-plugin/zipkin-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/zipkin/ZipkinReceiverModule.java @@ -28,7 +28,7 @@ import org.apache.skywalking.oap.server.library.module.ModuleDefine; * zipkin backend. */ public class ZipkinReceiverModule extends ModuleDefine { - public static final String NAME = "receiver_zipkin"; + public static final String NAME = "receiver-zipkin"; public ZipkinReceiverModule() { super(NAME); diff --git a/oap-server/server-starter/src/main/resources/application.yml b/oap-server/server-starter/src/main/resources/application.yml index eec290e816..b50c829d22 100755 --- a/oap-server/server-starter/src/main/resources/application.yml +++ b/oap-server/server-starter/src/main/resources/application.yml @@ -383,7 +383,7 @@ receiver-otel: enabledHandlers: ${SW_OTEL_RECEIVER_ENABLED_HANDLERS:"oc"} enabledOcRules: ${SW_OTEL_RECEIVER_ENABLED_OC_RULES:"istio-controlplane"} -receiver_zipkin: +receiver-zipkin: selector: ${SW_RECEIVER_ZIPKIN:-} default: host: ${SW_RECEIVER_ZIPKIN_HOST:0.0.0.0} @@ -396,12 +396,6 @@ receiver_zipkin: jettyAcceptQueueSize: ${SW_RECEIVER_ZIPKIN_QUEUE_SIZE:0} instanceNameRule: ${SW_RECEIVER_ZIPKIN_INSTANCE_NAME_RULE:[spring.instance_id,node_id]} -receiver_jaeger: - selector: ${SW_RECEIVER_JAEGER:-} - default: - gRPCHost: ${SW_RECEIVER_JAEGER_HOST:0.0.0.0} - gRPCPort: ${SW_RECEIVER_JAEGER_PORT:14250} - receiver-browser: selector: ${SW_RECEIVER_BROWSER:default} default: diff --git a/oap-server/server-starter/src/test/java/org/apache/skywalking/oap/server/starter/config/ApplicationConfigLoaderTestCase.java b/oap-server/server-starter/src/test/java/org/apache/skywalking/oap/server/starter/config/ApplicationConfigLoaderTestCase.java index 09f7871c77..ef42341084 100644 --- a/oap-server/server-starter/src/test/java/org/apache/skywalking/oap/server/starter/config/ApplicationConfigLoaderTestCase.java +++ b/oap-server/server-starter/src/test/java/org/apache/skywalking/oap/server/starter/config/ApplicationConfigLoaderTestCase.java @@ -55,7 +55,7 @@ public class ApplicationConfigLoaderTestCase { @Test public void testLoadListTypeConfig() { - Properties providerConfig = applicationConfiguration.getModuleConfiguration("receiver_zipkin") + Properties providerConfig = applicationConfiguration.getModuleConfiguration("receiver-zipkin") .getProviderConfiguration("default"); List instanceNameRule = (List) providerConfig.get("instanceNameRule"); assertEquals(2, instanceNameRule.size()); @@ -63,7 +63,7 @@ public class ApplicationConfigLoaderTestCase { @Test public void testLoadStringTypeConfig() { - Properties providerConfig = applicationConfiguration.getModuleConfiguration("receiver_zipkin") + Properties providerConfig = applicationConfiguration.getModuleConfiguration("receiver-zipkin") .getProviderConfiguration("default"); String host = (String) providerConfig.get("host"); assertEquals("0.0.0.0", host); @@ -71,7 +71,7 @@ public class ApplicationConfigLoaderTestCase { @Test public void testLoadIntegerTypeConfig() { - Properties providerConfig = applicationConfiguration.getModuleConfiguration("receiver_zipkin") + Properties providerConfig = applicationConfiguration.getModuleConfiguration("receiver-zipkin") .getProviderConfiguration("default"); Integer port = (Integer) providerConfig.get("port"); assertEquals(Integer.valueOf(9411), port);