From 08727e8e270ce355a51417d9604dfd2954b6fe6b Mon Sep 17 00:00:00 2001
From: Albumen Kevin <jhq0812@gmail.com>
Date: Fri, 19 May 2023 16:18:12 +0800
Subject: [PATCH] Metrics and Metadata Service Export when needed (#12346)

---
 .../dubbo/common/constants/CommonConstants.java   |  4 ++++
 .../org/apache/dubbo/config/MetricsConfig.java    | 15 ++++++++++++++-
 .../config/deploy/DefaultApplicationDeployer.java | 14 +++++++++-----
 .../config/metadata/ExporterDeployListener.java   | 11 ++++++++++-
 .../src/main/resources/META-INF/dubbo.xsd         |  6 ++++++
 5 files changed, 43 insertions(+), 7 deletions(-)

diff --git a/dubbo-common/src/main/java/org/apache/dubbo/common/constants/CommonConstants.java b/dubbo-common/src/main/java/org/apache/dubbo/common/constants/CommonConstants.java
index 266cacc7a5..0cc9e06c6f 100644
--- a/dubbo-common/src/main/java/org/apache/dubbo/common/constants/CommonConstants.java
+++ b/dubbo-common/src/main/java/org/apache/dubbo/common/constants/CommonConstants.java
@@ -239,6 +239,10 @@ public interface CommonConstants {
 
     String REMOTE_METADATA_STORAGE_TYPE = "remote";
 
+    String INTERFACE_REGISTER_MODE = "interface";
+
+    String DEFAULT_REGISTER_MODE = "all";
+
     String GENERIC_KEY = "generic";
 
     /**
diff --git a/dubbo-common/src/main/java/org/apache/dubbo/config/MetricsConfig.java b/dubbo-common/src/main/java/org/apache/dubbo/config/MetricsConfig.java
index 62e1882143..a7540dc63e 100644
--- a/dubbo-common/src/main/java/org/apache/dubbo/config/MetricsConfig.java
+++ b/dubbo-common/src/main/java/org/apache/dubbo/config/MetricsConfig.java
@@ -19,8 +19,8 @@ package org.apache.dubbo.config;
 import org.apache.dubbo.common.URL;
 import org.apache.dubbo.common.utils.UrlUtils;
 import org.apache.dubbo.config.nested.AggregationConfig;
-import org.apache.dubbo.config.nested.PrometheusConfig;
 import org.apache.dubbo.config.nested.HistogramConfig;
+import org.apache.dubbo.config.nested.PrometheusConfig;
 import org.apache.dubbo.config.support.Nested;
 import org.apache.dubbo.rpc.model.ApplicationModel;
 
@@ -56,6 +56,11 @@ public class MetricsConfig extends AbstractConfig {
      */
     private Boolean enableMetadata;
 
+    /**
+     * Export metrics service.
+     */
+    private Boolean exportMetricsService;
+
     /**
      * @deprecated After metrics config is refactored.
      * This parameter should no longer use and will be deleted in the future.
@@ -186,6 +191,14 @@ public class MetricsConfig extends AbstractConfig {
         this.enableMetadata = enableMetadata;
     }
 
+    public Boolean getExportMetricsService() {
+        return exportMetricsService;
+    }
+
+    public void setExportMetricsService(Boolean exportMetricsService) {
+        this.exportMetricsService = exportMetricsService;
+    }
+
     public Boolean getEnableThreadpool() {
         return enableThreadpool;
     }
diff --git a/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/deploy/DefaultApplicationDeployer.java b/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/deploy/DefaultApplicationDeployer.java
index 0e8fc3dd86..a7eede5af9 100644
--- a/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/deploy/DefaultApplicationDeployer.java
+++ b/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/deploy/DefaultApplicationDeployer.java
@@ -751,11 +751,15 @@ public class DefaultApplicationDeployer extends AbstractDeployer<ApplicationMode
     }
 
     private void exportMetricsService() {
-        try {
-            metricsServiceExporter.export();
-        } catch (Exception e) {
-            logger.error(LoggerCodeConstants.COMMON_METRICS_COLLECTOR_EXCEPTION, "", "",
-                "exportMetricsService an exception occurred when handle starting event", e);
+        boolean exportMetrics = applicationModel.getApplicationConfigManager().getMetrics()
+            .map(MetricsConfig::getExportMetricsService).orElse(true);
+        if (exportMetrics) {
+            try {
+                metricsServiceExporter.export();
+            } catch (Exception e) {
+                logger.error(LoggerCodeConstants.COMMON_METRICS_COLLECTOR_EXCEPTION, "", "",
+                    "exportMetricsService an exception occurred when handle starting event", e);
+            }
         }
     }
 
diff --git a/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/metadata/ExporterDeployListener.java b/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/metadata/ExporterDeployListener.java
index e7237c875d..f3e34bb4c9 100644
--- a/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/metadata/ExporterDeployListener.java
+++ b/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/metadata/ExporterDeployListener.java
@@ -23,6 +23,8 @@ import org.apache.dubbo.registry.client.metadata.MetadataServiceDelegation;
 import org.apache.dubbo.rpc.model.ApplicationModel;
 
 import static org.apache.dubbo.common.constants.CommonConstants.DEFAULT_METADATA_STORAGE_TYPE;
+import static org.apache.dubbo.common.constants.CommonConstants.DEFAULT_REGISTER_MODE;
+import static org.apache.dubbo.common.constants.CommonConstants.INTERFACE_REGISTER_MODE;
 import static org.apache.dubbo.common.constants.CommonConstants.REMOTE_METADATA_STORAGE_TYPE;
 
 public class ExporterDeployListener implements ApplicationDeployListener, Prioritized {
@@ -56,6 +58,13 @@ public class ExporterDeployListener implements ApplicationDeployListener, Priori
         return type;
     }
 
+    private String getRegisterMode(ApplicationModel applicationModel) {
+        String type = applicationModel.getApplicationConfigManager().getApplicationOrElseThrow().getRegisterMode();
+        if (StringUtils.isEmpty(type)) {
+            type = DEFAULT_REGISTER_MODE;
+        }
+        return type;
+    }
 
     public ConfigurableMetadataServiceExporter getMetadataServiceExporter() {
         return metadataServiceExporter;
@@ -72,7 +81,7 @@ public class ExporterDeployListener implements ApplicationDeployListener, Priori
         if (metadataServiceExporter == null) {
             metadataServiceExporter = new ConfigurableMetadataServiceExporter(applicationModel, metadataService);
             // fixme, let's disable local metadata service export at this moment
-            if (!REMOTE_METADATA_STORAGE_TYPE.equals(getMetadataType(applicationModel))) {
+            if (!REMOTE_METADATA_STORAGE_TYPE.equals(getMetadataType(applicationModel)) && !INTERFACE_REGISTER_MODE.equals(getRegisterMode(applicationModel))) {
                 metadataServiceExporter.export();
             }
         }
diff --git a/dubbo-config/dubbo-config-spring/src/main/resources/META-INF/dubbo.xsd b/dubbo-config/dubbo-config-spring/src/main/resources/META-INF/dubbo.xsd
index 24b4cb2a3f..ff36236df0 100644
--- a/dubbo-config/dubbo-config-spring/src/main/resources/META-INF/dubbo.xsd
+++ b/dubbo-config/dubbo-config-spring/src/main/resources/META-INF/dubbo.xsd
@@ -1087,6 +1087,12 @@
             </xsd:annotation>
         </xsd:attribute>
 
+        <xsd:attribute name="export-metrics-service" type="xsd:boolean" default="true">
+            <xsd:annotation>
+                <xsd:documentation><![CDATA[ Enable export metrics service. ]]></xsd:documentation>
+            </xsd:annotation>
+        </xsd:attribute>
+
         <xsd:attribute name="port" type="xsd:string">
             <xsd:annotation>
                 <xsd:documentation><![CDATA[ Deprecated. No longer use. ]]></xsd:documentation>