move non-api classes to internal packages (open-telemetry#11502)

Abhishekkr3003 · Jun 5, 2024 · d991af7 · d991af7
1 parent b8b1bff
commit d991af7
Show file tree

Hide file tree

Showing 12 changed files with 62 additions and 31 deletions.
diff --git a/...io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java b/...io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java
@@ -9,12 +9,12 @@
 import io.opentelemetry.api.trace.TracerProvider;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.MapConverter;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.SdkEnabled;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.OtelResourceProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.OtlpExporterProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.PropagationProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.SpringConfigProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.resources.DistroVersionResourceProvider;
-import io.opentelemetry.instrumentation.spring.autoconfigure.resources.SpringResourceProvider;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtelResourceProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtlpExporterProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.PropagationProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.SpringConfigProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources.DistroVersionResourceProvider;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources.SpringResourceProvider;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.internal.AutoConfigureUtil;
 import io.opentelemetry.sdk.autoconfigure.internal.ComponentLoader;
@@ -60,7 +60,7 @@ public OpenTelemetryAutoConfiguration() {}
   @Configuration
   @Conditional(SdkEnabled.class)
   @ConditionalOnMissingBean(OpenTelemetry.class)
-  public static class OpenTelemetrySdkConfig {
+  static class OpenTelemetrySdkConfig {
 
     @Bean
     @ConfigurationPropertiesBinding
@@ -131,7 +131,7 @@ public ConfigProperties otelProperties(
   @Configuration
   @ConditionalOnMissingBean(OpenTelemetry.class)
   @ConditionalOnProperty(name = "otel.sdk.disabled", havingValue = "true")
-  public static class DisabledOpenTelemetrySdkConfig {
+  static class DisabledOpenTelemetrySdkConfig {
 
     @Bean
     public OpenTelemetry openTelemetry() {
@@ -147,7 +147,7 @@ public ConfigProperties otelProperties() {
   @Configuration
   @ConditionalOnBean(OpenTelemetry.class)
   @ConditionalOnMissingBean({ConfigProperties.class})
-  public static class FallbackConfigProperties {
+  static class FallbackConfigProperties {
     @Bean
     public ConfigProperties otelProperties() {
       return DefaultConfigProperties.create(Collections.emptyMap());
@@ -159,7 +159,7 @@ public ConfigProperties otelProperties() {
    * <a
    * href="https://github.com/open-telemetry/opentelemetry-java/blob/4519a7e90243e5b75b3a46a14c872de88b95a9a1/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdkBuilder.java#L405-L408">here</a>
    */
-  public static class OpenTelemetrySdkComponentLoader implements ComponentLoader {
+  static class OpenTelemetrySdkComponentLoader implements ComponentLoader {
     private final ApplicationContext applicationContext;
 
     private final SpiHelper spiHelper =

diff --git a/...ring/autoconfigure/instrumentation/mongo/MongoClientInstrumentationAutoConfiguration.java b/...ring/autoconfigure/instrumentation/mongo/MongoClientInstrumentationAutoConfiguration.java
@@ -27,7 +27,7 @@
 public class MongoClientInstrumentationAutoConfiguration {
 
   @Bean
-  public MongoClientSettingsBuilderCustomizer customizer(
+  MongoClientSettingsBuilderCustomizer customizer(
       OpenTelemetry openTelemetry, ConfigProperties config) {
     return builder ->
         builder.addCommandListener(

diff --git a/...re/properties/OtelResourceProperties.java → ...al/properties/OtelResourceProperties.java b/...re/properties/OtelResourceProperties.java → ...al/properties/OtelResourceProperties.java
@@ -3,12 +3,16 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.properties;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties;
 
 import java.util.Collections;
 import java.util.Map;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
 @ConfigurationProperties(prefix = "otel.resource")
 public class OtelResourceProperties {
   private Map<String, String> attributes = Collections.emptyMap();

diff --git a/...re/properties/OtlpExporterProperties.java → ...al/properties/OtlpExporterProperties.java b/...re/properties/OtlpExporterProperties.java → ...al/properties/OtlpExporterProperties.java
@@ -3,13 +3,16 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.properties;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties;
 
 import java.util.HashMap;
 import java.util.Map;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
-/** Configuration for OLTP exporters. */
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
 @ConfigurationProperties(prefix = "otel.exporter.otlp")
 public final class OtlpExporterProperties {
 
@@ -35,6 +38,10 @@ public SignalProperties getLogs() {
     return logs;
   }
 
+  /**
+   * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+   * any time.
+   */
   public static class SignalProperties {
     private final Map<String, String> headers = new HashMap<>();
 

diff --git a/...ure/properties/PropagationProperties.java → ...nal/properties/PropagationProperties.java b/...ure/properties/PropagationProperties.java → ...nal/properties/PropagationProperties.java
@@ -3,13 +3,16 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.properties;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties;
 
 import java.util.Collections;
 import java.util.List;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
-/** Configuration for propagators. */
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
 @ConfigurationProperties(prefix = "otel")
 public final class PropagationProperties {
 

diff --git a/...re/properties/SpringConfigProperties.java → ...al/properties/SpringConfigProperties.java b/...re/properties/SpringConfigProperties.java → ...al/properties/SpringConfigProperties.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.properties;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties;
 
 import io.opentelemetry.exporter.otlp.internal.OtlpConfigUtil;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
@@ -18,6 +18,10 @@
 import org.springframework.expression.ExpressionParser;
 import org.springframework.expression.spel.standard.SpelExpressionParser;
 
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
 public class SpringConfigProperties implements ConfigProperties {
   private final Environment environment;
 

diff --git a/...ources/DistroVersionResourceProvider.java → ...ources/DistroVersionResourceProvider.java b/...ources/DistroVersionResourceProvider.java → ...ources/DistroVersionResourceProvider.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.resources;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources;
 
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
@@ -12,6 +12,10 @@
 import io.opentelemetry.sdk.autoconfigure.spi.ResourceProvider;
 import io.opentelemetry.sdk.resources.Resource;
 
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
 public class DistroVersionResourceProvider implements ResourceProvider {
 
   public static final String VERSION =

diff --git a/...ure/resources/SpringResourceProvider.java → ...nal/resources/SpringResourceProvider.java b/...ure/resources/SpringResourceProvider.java → ...nal/resources/SpringResourceProvider.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.resources;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources;
 
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.common.AttributesBuilder;
@@ -14,6 +14,10 @@
 import java.util.Optional;
 import org.springframework.boot.info.BuildProperties;
 
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
 public class SpringResourceProvider implements ResourceProvider {
 
   private final Optional<BuildProperties> buildProperties;

diff --git a/...telemetry/instrumentation/spring/autoconfigure/properties/OtlpExporterPropertiesTest.java b/...telemetry/instrumentation/spring/autoconfigure/properties/OtlpExporterPropertiesTest.java
@@ -9,6 +9,10 @@
 import static org.assertj.core.api.Assertions.entry;
 
 import io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtelResourceProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtlpExporterProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.PropagationProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.SpringConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
 import java.util.Arrays;

diff --git a/...ntelemetry/instrumentation/spring/autoconfigure/resources/SpringConfigPropertiesTest.java b/...ntelemetry/instrumentation/spring/autoconfigure/resources/SpringConfigPropertiesTest.java
@@ -9,10 +9,10 @@
 import static org.assertj.core.api.Assertions.entry;
 
 import io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.OtelResourceProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.OtlpExporterProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.PropagationProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.SpringConfigProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtelResourceProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtlpExporterProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.PropagationProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.SpringConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
 import java.util.HashMap;
 import java.util.Map;

diff --git a/...ntelemetry/instrumentation/spring/autoconfigure/resources/SpringResourceProviderTest.java b/...ntelemetry/instrumentation/spring/autoconfigure/resources/SpringResourceProviderTest.java
@@ -6,10 +6,11 @@
 package io.opentelemetry.instrumentation.spring.autoconfigure.resources;
 
 import io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.OtelResourceProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.OtlpExporterProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.PropagationProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.SpringConfigProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtelResourceProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtlpExporterProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.PropagationProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.SpringConfigProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources.SpringResourceProvider;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
 import io.opentelemetry.sdk.testing.assertj.AttributesAssert;

diff --git a/...n/src/main/java/io/opentelemetry/spring/smoketest/AbstractOtelSpringStarterSmokeTest.java b/...n/src/main/java/io/opentelemetry/spring/smoketest/AbstractOtelSpringStarterSmokeTest.java
@@ -10,10 +10,10 @@
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.trace.SpanKind;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.OtelResourceProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.OtlpExporterProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.PropagationProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.properties.SpringConfigProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtelResourceProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtlpExporterProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.PropagationProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.SpringConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;