fix: add micrometer bom to observability & optimize the structure of …

…the package (#11724) * chore: optimize the structure of the package * chore: add micrometer bom to observability --------- Co-authored-by: Albumen Kevin <jhq0812@gmail.com>
apache · Mar 6, 2023 · d3d8c54 · d3d8c54
1 parent d711300
commit d3d8c54
Show file tree

Hide file tree

Showing 13 changed files with 43 additions and 31 deletions.
diff --git a/...actDefaultDubboObservationConvention.java → ...actDefaultDubboObservationConvention.java b/...actDefaultDubboObservationConvention.java → ...actDefaultDubboObservationConvention.java
@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.dubbo.metrics.filter.observation;
+package org.apache.dubbo.metrics.observation;
 
 import io.micrometer.common.KeyValues;
 import io.micrometer.common.docs.KeyName;
@@ -25,9 +25,9 @@
 import org.apache.dubbo.rpc.Invocation;
 import org.apache.dubbo.rpc.support.RpcUtils;
 
-import static org.apache.dubbo.metrics.filter.observation.DubboObservation.LowCardinalityKeyNames.RPC_METHOD;
-import static org.apache.dubbo.metrics.filter.observation.DubboObservation.LowCardinalityKeyNames.RPC_SERVICE;
-import static org.apache.dubbo.metrics.filter.observation.DubboObservation.LowCardinalityKeyNames.RPC_SYSTEM;
+import static org.apache.dubbo.metrics.observation.DubboObservation.LowCardinalityKeyNames.RPC_METHOD;
+import static org.apache.dubbo.metrics.observation.DubboObservation.LowCardinalityKeyNames.RPC_SERVICE;
+import static org.apache.dubbo.metrics.observation.DubboObservation.LowCardinalityKeyNames.RPC_SYSTEM;
 
 class AbstractDefaultDubboObservationConvention {
     KeyValues getLowCardinalityKeyValues(Invocation invocation) {

diff --git a/...aultDubboClientObservationConvention.java → ...aultDubboClientObservationConvention.java b/...aultDubboClientObservationConvention.java → ...aultDubboClientObservationConvention.java
@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.dubbo.metrics.filter.observation;
+package org.apache.dubbo.metrics.observation;
 
 import java.util.List;
 
@@ -24,8 +24,8 @@
 import org.apache.dubbo.rpc.RpcContext;
 import org.apache.dubbo.rpc.RpcContextAttachment;
 
-import static org.apache.dubbo.metrics.filter.observation.DubboObservation.LowCardinalityKeyNames.NET_PEER_NAME;
-import static org.apache.dubbo.metrics.filter.observation.DubboObservation.LowCardinalityKeyNames.NET_PEER_PORT;
+import static org.apache.dubbo.metrics.observation.DubboObservation.LowCardinalityKeyNames.NET_PEER_NAME;
+import static org.apache.dubbo.metrics.observation.DubboObservation.LowCardinalityKeyNames.NET_PEER_PORT;
 
 /**
  * Default implementation of the {@link DubboClientObservationConvention}.

diff --git a/...aultDubboServerObservationConvention.java → ...aultDubboServerObservationConvention.java b/...aultDubboServerObservationConvention.java → ...aultDubboServerObservationConvention.java
@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.dubbo.metrics.filter.observation;
+package org.apache.dubbo.metrics.observation;
 
 import io.micrometer.common.KeyValues;
 

diff --git a/...ilter/observation/DubboClientContext.java → ...trics/observation/DubboClientContext.java b/...ilter/observation/DubboClientContext.java → ...trics/observation/DubboClientContext.java
@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.dubbo.metrics.filter.observation;
+package org.apache.dubbo.metrics.observation;
 
 import java.util.Objects;
 

diff --git a/...ion/DubboClientObservationConvention.java → ...ion/DubboClientObservationConvention.java b/...ion/DubboClientObservationConvention.java → ...ion/DubboClientObservationConvention.java
@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.dubbo.metrics.filter.observation;
+package org.apache.dubbo.metrics.observation;
 
 import io.micrometer.observation.Observation;
 import io.micrometer.observation.ObservationConvention;

diff --git a/.../filter/observation/DubboObservation.java → ...metrics/observation/DubboObservation.java b/.../filter/observation/DubboObservation.java → ...metrics/observation/DubboObservation.java
@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.dubbo.metrics.filter.observation;
+package org.apache.dubbo.metrics.observation;
 
 import io.micrometer.common.docs.KeyName;
 import io.micrometer.observation.Observation;

diff --git a/...ilter/observation/DubboServerContext.java → ...trics/observation/DubboServerContext.java b/...ilter/observation/DubboServerContext.java → ...trics/observation/DubboServerContext.java
@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.dubbo.metrics.filter.observation;
+package org.apache.dubbo.metrics.observation;
 
 import io.micrometer.observation.transport.ReceiverContext;
 import org.apache.dubbo.rpc.Invocation;

diff --git a/...ion/DubboServerObservationConvention.java → ...ion/DubboServerObservationConvention.java b/...ion/DubboServerObservationConvention.java → ...ion/DubboServerObservationConvention.java
@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.dubbo.metrics.filter.observation;
+package org.apache.dubbo.metrics.observation;
 
 import io.micrometer.observation.Observation;
 import io.micrometer.observation.ObservationConvention;

diff --git a/...default/src/main/java/org/apache/dubbo/metrics/observation/ObservationReceiverFilter.java b/...default/src/main/java/org/apache/dubbo/metrics/observation/ObservationReceiverFilter.java
@@ -20,10 +20,6 @@
 import io.micrometer.observation.ObservationRegistry;
 
 import org.apache.dubbo.common.extension.Activate;
-import org.apache.dubbo.metrics.filter.observation.DefaultDubboServerObservationConvention;
-import org.apache.dubbo.metrics.filter.observation.DubboObservation;
-import org.apache.dubbo.metrics.filter.observation.DubboServerContext;
-import org.apache.dubbo.metrics.filter.observation.DubboServerObservationConvention;
 import org.apache.dubbo.rpc.BaseFilter;
 import org.apache.dubbo.rpc.Filter;
 import org.apache.dubbo.rpc.Invocation;

diff --git a/...s-default/src/main/java/org/apache/dubbo/metrics/observation/ObservationSenderFilter.java b/...s-default/src/main/java/org/apache/dubbo/metrics/observation/ObservationSenderFilter.java
@@ -20,10 +20,6 @@
 import io.micrometer.observation.ObservationRegistry;
 
 import org.apache.dubbo.common.extension.Activate;
-import org.apache.dubbo.metrics.filter.observation.DefaultDubboClientObservationConvention;
-import org.apache.dubbo.metrics.filter.observation.DubboClientContext;
-import org.apache.dubbo.metrics.filter.observation.DubboClientObservationConvention;
-import org.apache.dubbo.metrics.filter.observation.DubboObservation;
 import org.apache.dubbo.rpc.BaseFilter;
 import org.apache.dubbo.rpc.Filter;
 import org.apache.dubbo.rpc.Invocation;

diff --git a/dubbo-spring-boot/dubbo-spring-boot-observability-starter/pom.xml b/dubbo-spring-boot/dubbo-spring-boot-observability-starter/pom.xml
@@ -28,6 +28,30 @@
 
     <artifactId>dubbo-spring-boot-observability-starter</artifactId>
 
+    <properties>
+        <micrometer.version>1.10.4</micrometer.version>
+        <micrometer-tracing.version>1.0.2</micrometer-tracing.version>
+    </properties>
+
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>io.micrometer</groupId>
+                <artifactId>micrometer-bom</artifactId>
+                <version>${micrometer.version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+            <dependency>
+                <groupId>io.micrometer</groupId>
+                <artifactId>micrometer-tracing-bom</artifactId>
+                <version>${micrometer-tracing.version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
     <dependencies>
         <dependency>
             <groupId>io.micrometer</groupId>

diff --git a/...ache/dubbo/spring/boot/observability/autoconfigure/DubboObservationAutoConfiguration.java b/...ache/dubbo/spring/boot/observability/autoconfigure/DubboObservationAutoConfiguration.java
@@ -25,8 +25,10 @@
 import io.micrometer.tracing.Tracer;
 import io.micrometer.tracing.handler.TracingAwareMeterObservationHandler;
 import io.micrometer.tracing.handler.TracingObservationHandler;
+
 import org.apache.dubbo.rpc.model.ApplicationModel;
 import org.apache.dubbo.spring.boot.observability.annotation.ConditionalOnDubboTracingEnable;
+
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.BeanFactoryAware;
@@ -46,7 +48,7 @@
  * Register observationRegistry to ApplicationModel.
  * Create observationRegistry when you are using Boot <3.0 or you are not using spring-boot-starter-actuator
  */
-@AutoConfiguration(after =DubboMicrometerTracingAutoConfiguration.class,afterName = "org.springframework.boot.actuate.autoconfigure.observation.ObservationAutoConfiguration")
+@AutoConfiguration(after = DubboMicrometerTracingAutoConfiguration.class, afterName = "org.springframework.boot.actuate.autoconfigure.observation.ObservationAutoConfiguration")
 @ConditionalOnDubboTracingEnable
 public class DubboObservationAutoConfiguration implements BeanFactoryAware, SmartInitializingSingleton {
 
@@ -108,14 +110,14 @@ ObservationHandlerGrouping tracingObservationHandlerGrouping() {
     }
 
     @Configuration(proxyBeanMethods = false)
-    @ConditionalOnClass({ MeterRegistry.class, Tracer.class })
+    @ConditionalOnClass({MeterRegistry.class, Tracer.class})
     @ConditionalOnMissingBean(type = "org.springframework.boot.actuate.autoconfigure.observation.ObservationRegistryPostProcessor")
     static class MetricsWithTracingConfiguration {
 
         @Bean
         ObservationHandlerGrouping metricsAndTracingObservationHandlerGrouping() {
             return new ObservationHandlerGrouping(
-               Arrays.asList(TracingObservationHandler.class, MeterObservationHandler.class));
+                    Arrays.asList(TracingObservationHandler.class, MeterObservationHandler.class));
         }
 
     }
@@ -142,7 +144,7 @@ static class TracingAndMetricsObservationHandlerConfiguration {
 
             @Bean
             TracingAwareMeterObservationHandler<Observation.Context> tracingAwareMeterObservationHandler(
-                MeterRegistry meterRegistry, Tracer tracer) {
+                    MeterRegistry meterRegistry, Tracer tracer) {
                 DefaultMeterObservationHandler delegate = new DefaultMeterObservationHandler(meterRegistry);
                 return new TracingAwareMeterObservationHandler<>(delegate, tracer);
             }

diff --git a/dubbo-spring-boot/pom.xml b/dubbo-spring-boot/pom.xml
@@ -46,7 +46,6 @@
         <log4j2_version>2.20.0</log4j2_version>
         <!-- Spring boot buddy is lower than the delivery dependency package version and can only show the defined dependency version -->
         <byte-buddy.version>1.14.0</byte-buddy.version>
-        <micrometer-core.version>1.10.4</micrometer-core.version>
     </properties>
 
     <dependencyManagement>
@@ -59,11 +58,6 @@
                 <type>pom</type>
                 <scope>import</scope>
             </dependency>
-            <dependency>
-                <groupId>io.micrometer</groupId>
-                <artifactId>micrometer-core</artifactId>
-                <version>${micrometer-core.version}</version>
-            </dependency>
         </dependencies>
     </dependencyManagement>