refactor: implement OTEL handler with SPI for extensibility

Author: kezhenxu94

docs/en/changes/changes.md

@@ -42,6 +42,7 @@
 * Implement the Status API on Settings page.
 * Bump vite from 6.2.6 to 6.3.4.
 * Enhance async profiling by adding shorter and custom duration options.
+* refactor: implement OTEL handler with SPI for extensibility.
 
 #### Documentation
 

oap-server/server-receiver-plugin/otel-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/otel/Handler.java

@@ -18,9 +18,12 @@
 
 package org.apache.skywalking.oap.server.receiver.otel;
 
+import org.apache.skywalking.oap.server.library.module.ModuleManager;
 import org.apache.skywalking.oap.server.library.module.ModuleStartException;
 
 public interface Handler {
+    void init(ModuleManager manager, OtelMetricReceiverConfig config);
+
     String type();
 
     void active() throws ModuleStartException;

oap-server/server-receiver-plugin/otel-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/otel/OtelMetricReceiverProvider.java

@@ -22,14 +22,12 @@
 import org.apache.skywalking.oap.server.library.module.ModuleProvider;
 import org.apache.skywalking.oap.server.library.module.ModuleStartException;
 import org.apache.skywalking.oap.server.library.module.ServiceNotProvidedException;
-import org.apache.skywalking.oap.server.receiver.otel.otlp.OpenTelemetryLogHandler;
-import org.apache.skywalking.oap.server.receiver.otel.otlp.OpenTelemetryMetricHandler;
 import org.apache.skywalking.oap.server.receiver.otel.otlp.OpenTelemetryMetricRequestProcessor;
-import org.apache.skywalking.oap.server.receiver.otel.otlp.OpenTelemetryTraceHandler;
 import org.apache.skywalking.oap.server.receiver.sharing.server.SharingServerModule;
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.ServiceLoader;
 
 public class OtelMetricReceiverProvider extends ModuleProvider {
     public static final String NAME = "default";
@@ -71,19 +69,13 @@ public void prepare() throws ServiceNotProvidedException, ModuleStartException {
             getManager(), config);
         registerServiceImplementation(OpenTelemetryMetricRequestProcessor.class, metricRequestProcessor);
         final List<String> enabledHandlers = config.getEnabledHandlers();
-        List<Handler> handlers = new ArrayList<>();
 
-        final var openTelemetryMetricHandler = new OpenTelemetryMetricHandler(getManager(), metricRequestProcessor);
-        if (enabledHandlers.contains(openTelemetryMetricHandler.type())) {
-            handlers.add(openTelemetryMetricHandler);
-        }
-        final var openTelemetryLogHandler = new OpenTelemetryLogHandler(getManager());
-        if (enabledHandlers.contains(openTelemetryLogHandler.type())) {
-            handlers.add(openTelemetryLogHandler);
-        }
-        final var openTelemetryTraceHandler = new OpenTelemetryTraceHandler(getManager());
-        if (enabledHandlers.contains(openTelemetryTraceHandler.type())) {
-            handlers.add(openTelemetryTraceHandler);
+        final var handlers = new ArrayList<Handler>();
+        for (final var handler: ServiceLoader.load(Handler.class)) {
+            if (enabledHandlers.contains(handler.type())) {
+                handler.init(getManager(), config);
+                handlers.add(handler);
+            }
         }
         this.handlers = handlers;
     }

oap-server/server-receiver-plugin/otel-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/otel/otlp/OpenTelemetryLogHandler.java

@@ -39,6 +39,7 @@
 import org.apache.skywalking.oap.server.library.module.ModuleManager;
 import org.apache.skywalking.oap.server.library.module.ModuleStartException;
 import org.apache.skywalking.oap.server.receiver.otel.Handler;
+import org.apache.skywalking.oap.server.receiver.otel.OtelMetricReceiverConfig;
 import org.apache.skywalking.oap.server.receiver.sharing.server.SharingServerModule;
 import org.apache.skywalking.oap.server.telemetry.TelemetryModule;
 import org.apache.skywalking.oap.server.telemetry.api.HistogramMetrics;
@@ -55,7 +56,7 @@
 public class OpenTelemetryLogHandler
     extends LogsServiceGrpc.LogsServiceImplBase
     implements Handler {
-    private final ModuleManager manager;
+    private ModuleManager manager;
 
     private ILogAnalyzerService logAnalyzerService;
 
@@ -70,6 +71,11 @@ public class OpenTelemetryLogHandler
         MetricsTag.EMPTY_VALUE
     );
 
+    @Override
+    public void init(ModuleManager manager, OtelMetricReceiverConfig config) {
+        this.manager = manager;
+    }
+
     @Override
     public String type() {
         return "otlp-logs";

oap-server/server-receiver-plugin/otel-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/otel/otlp/OpenTelemetryMetricHandler.java

@@ -22,22 +22,30 @@
 import io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceRequest;
 import io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceResponse;
 import io.opentelemetry.proto.collector.metrics.v1.MetricsServiceGrpc;
-import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.skywalking.oap.server.core.server.GRPCHandlerRegister;
 import org.apache.skywalking.oap.server.library.module.ModuleManager;
 import org.apache.skywalking.oap.server.library.module.ModuleStartException;
 import org.apache.skywalking.oap.server.receiver.otel.Handler;
+import org.apache.skywalking.oap.server.receiver.otel.OtelMetricReceiverConfig;
+import org.apache.skywalking.oap.server.receiver.otel.OtelMetricReceiverModule;
 import org.apache.skywalking.oap.server.receiver.sharing.server.SharingServerModule;
 
 @Slf4j
-@RequiredArgsConstructor
 public class OpenTelemetryMetricHandler
     extends MetricsServiceGrpc.MetricsServiceImplBase
     implements Handler {
-    private final ModuleManager manager;
 
-    private final OpenTelemetryMetricRequestProcessor metricRequestProcessor;
+    private OpenTelemetryMetricRequestProcessor metricRequestProcessor;
+    private ModuleManager manager;
+
+    @Override
+    public void init(ModuleManager manager, OtelMetricReceiverConfig config) {
+        this.manager = manager;
+        metricRequestProcessor = manager.find(OtelMetricReceiverModule.NAME)
+                                        .provider()
+                                        .getService(OpenTelemetryMetricRequestProcessor.class);
+    }
 
     @Override
     public String type() {

oap-server/server-receiver-plugin/otel-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/otel/otlp/OpenTelemetryTraceHandler.java

@@ -31,13 +31,13 @@
 import io.opentelemetry.proto.trace.v1.ScopeSpans;
 import io.opentelemetry.proto.trace.v1.Status;
 import lombok.Getter;
-import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.skywalking.oap.server.core.server.GRPCHandlerRegister;
 import org.apache.skywalking.oap.server.library.module.ModuleManager;
 import org.apache.skywalking.oap.server.library.module.ModuleStartException;
 import org.apache.skywalking.oap.server.library.util.StringUtil;
 import org.apache.skywalking.oap.server.receiver.otel.Handler;
+import org.apache.skywalking.oap.server.receiver.otel.OtelMetricReceiverConfig;
 import org.apache.skywalking.oap.server.receiver.sharing.server.SharingServerModule;
 import org.apache.skywalking.oap.server.receiver.zipkin.SpanForwardService;
 import org.apache.skywalking.oap.server.receiver.zipkin.ZipkinReceiverModule;
@@ -62,11 +62,10 @@
 import java.util.stream.Collectors;
 
 @Slf4j
-@RequiredArgsConstructor
 public class OpenTelemetryTraceHandler
     extends TraceServiceGrpc.TraceServiceImplBase
     implements Handler {
-    private final ModuleManager manager;
+    private ModuleManager manager;
     private SpanForwardService forwardService;
 
     @Getter(lazy = true)
@@ -80,6 +79,11 @@ public class OpenTelemetryTraceHandler
         MetricsTag.EMPTY_VALUE
     );
 
+    @Override
+    public void init(ModuleManager manager, OtelMetricReceiverConfig config) {
+        this.manager = manager;
+    }
+
     @Override
     public String type() {
         return "otlp-traces";

oap-server/server-receiver-plugin/otel-receiver-plugin/src/main/resources/META-INF/services/org.apache.skywalking.oap.server.receiver.otel.Handler

@@ -0,0 +1,21 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+#
+
+org.apache.skywalking.oap.server.receiver.otel.otlp.OpenTelemetryMetricHandler
+org.apache.skywalking.oap.server.receiver.otel.otlp.OpenTelemetryLogHandler
+org.apache.skywalking.oap.server.receiver.otel.otlp.OpenTelemetryTraceHandler