Rename to declarative configuration

Author: jack-berg

api/incubator/src/main/java/io/opentelemetry/api/incubator/config/ConfigProvider.java

@@ -9,7 +9,7 @@
 import javax.annotation.concurrent.ThreadSafe;
 
 /**
- * A registry for accessing configuration.
+ * A registry for accessing declarative configuration.
  *
  * <p>The name <i>Provider</i> is for consistency with other languages and it is <b>NOT</b> loaded
  * using reflection.
@@ -21,14 +21,14 @@
 public interface ConfigProvider {
 
   /**
-   * Returns the {@link StructuredConfigProperties} corresponding to <a
+   * Returns the {@link DeclarativeConfigProperties} corresponding to <a
    * href="https://github.com/open-telemetry/opentelemetry-configuration/blob/main/schema/instrumentation.json">instrumentation
    * config</a>, or {@code null} if unavailable.
    *
-   * @return the instrumentation {@link StructuredConfigProperties}
+   * @return the instrumentation {@link DeclarativeConfigProperties}
    */
   @Nullable
-  StructuredConfigProperties getInstrumentationConfig();
+  DeclarativeConfigProperties getInstrumentationConfig();
 
   /** Returns a no-op {@link ConfigProvider}. */
   static ConfigProvider noop() {

…or/config/StructuredConfigException.java …r/config/DeclarativeConfigException.javaapi/incubator/src/main/java/io/opentelemetry/api/incubator/config/StructuredConfigException.java renamed to api/incubator/src/main/java/io/opentelemetry/api/incubator/config/DeclarativeConfigException.java api/incubator/src/main/java/io/opentelemetry/api/incubator/config/StructuredConfigException.java renamed to api/incubator/src/main/java/io/opentelemetry/api/incubator/config/DeclarativeConfigException.java

@@ -5,18 +5,18 @@
 
 package io.opentelemetry.api.incubator.config;
 
-/** An exception that is thrown if the user-provided file configuration is invalid. */
-public final class StructuredConfigException extends RuntimeException {
+/** An exception that is thrown when errors occur with declarative configuration. */
+public final class DeclarativeConfigException extends RuntimeException {
 
   private static final long serialVersionUID = 3036584181551130522L;
 
   /** Create a new configuration exception with specified {@code message} and without a cause. */
-  public StructuredConfigException(String message) {
+  public DeclarativeConfigException(String message) {
     super(message);
   }
 
   /** Create a new configuration exception with specified {@code message} and {@code cause}. */
-  public StructuredConfigException(String message, Throwable cause) {
+  public DeclarativeConfigException(String message, Throwable cause) {
     super(message, cause);
   }
 }

…r/config/StructuredConfigProperties.java …/config/DeclarativeConfigProperties.javaapi/incubator/src/main/java/io/opentelemetry/api/incubator/config/StructuredConfigProperties.java renamed to api/incubator/src/main/java/io/opentelemetry/api/incubator/config/DeclarativeConfigProperties.java api/incubator/src/main/java/io/opentelemetry/api/incubator/config/StructuredConfigProperties.java renamed to api/incubator/src/main/java/io/opentelemetry/api/incubator/config/DeclarativeConfigProperties.java

@@ -12,21 +12,21 @@
 import javax.annotation.Nullable;
 
 /**
- * An interface for accessing structured configuration data.
+ * An interface for accessing declarative configuration data.
  *
- * <p>An instance of {@link StructuredConfigProperties} is equivalent to a <a
+ * <p>An instance of {@link DeclarativeConfigProperties} is equivalent to a <a
  * href="https://yaml.org/spec/1.2.2/#3211-nodes">YAML mapping node</a>. It has accessors for
  * reading scalar properties, {@link #getStructured(String)} for reading children which are
  * themselves mappings, and {@link #getStructuredList(String)} for reading children which are
  * sequences of mappings.
  */
-public interface StructuredConfigProperties {
+public interface DeclarativeConfigProperties {
 
   /**
    * Returns a {@link String} configuration property.
    *
    * @return null if the property has not been configured
-   * @throws StructuredConfigException if the property is not a valid scalar string
+   * @throws DeclarativeConfigException if the property is not a valid scalar string
    */
   @Nullable
   String getString(String name);
@@ -36,7 +36,7 @@ public interface StructuredConfigProperties {
    *
    * @return a {@link String} configuration property or {@code defaultValue} if a property with
    *     {@code name} has not been configured
-   * @throws StructuredConfigException if the property is not a valid scalar string
+   * @throws DeclarativeConfigException if the property is not a valid scalar string
    */
   default String getString(String name, String defaultValue) {
     return defaultIfNull(getString(name), defaultValue);
@@ -47,7 +47,7 @@ default String getString(String name, String defaultValue) {
    * {@link Boolean#parseBoolean(String)} for handling the values.
    *
    * @return null if the property has not been configured
-   * @throws StructuredConfigException if the property is not a valid scalar boolean
+   * @throws DeclarativeConfigException if the property is not a valid scalar boolean
    */
   @Nullable
   Boolean getBoolean(String name);
@@ -57,7 +57,7 @@ default String getString(String name, String defaultValue) {
    *
    * @return a {@link Boolean} configuration property or {@code defaultValue} if a property with
    *     {@code name} has not been configured
-   * @throws StructuredConfigException if the property is not a valid scalar boolean
+   * @throws DeclarativeConfigException if the property is not a valid scalar boolean
    */
   default boolean getBoolean(String name, boolean defaultValue) {
     return defaultIfNull(getBoolean(name), defaultValue);
@@ -70,7 +70,7 @@ default boolean getBoolean(String name, boolean defaultValue) {
    * {@link Long#intValue()} which may result in loss of precision.
    *
    * @return null if the property has not been configured
-   * @throws StructuredConfigException if the property is not a valid scalar integer
+   * @throws DeclarativeConfigException if the property is not a valid scalar integer
    */
   @Nullable
   Integer getInt(String name);
@@ -83,7 +83,7 @@ default boolean getBoolean(String name, boolean defaultValue) {
    *
    * @return a {@link Integer} configuration property or {@code defaultValue} if a property with
    *     {@code name} has not been configured
-   * @throws StructuredConfigException if the property is not a valid scalar integer
+   * @throws DeclarativeConfigException if the property is not a valid scalar integer
    */
   default int getInt(String name, int defaultValue) {
     return defaultIfNull(getInt(name), defaultValue);
@@ -93,7 +93,7 @@ default int getInt(String name, int defaultValue) {
    * Returns a {@link Long} configuration property.
    *
    * @return null if the property has not been configured
-   * @throws StructuredConfigException if the property is not a valid scalar long
+   * @throws DeclarativeConfigException if the property is not a valid scalar long
    */
   @Nullable
   Long getLong(String name);
@@ -103,7 +103,7 @@ default int getInt(String name, int defaultValue) {
    *
    * @return a {@link Long} configuration property or {@code defaultValue} if a property with {@code
    *     name} has not been configured
-   * @throws StructuredConfigException if the property is not a valid scalar long
+   * @throws DeclarativeConfigException if the property is not a valid scalar long
    */
   default long getLong(String name, long defaultValue) {
     return defaultIfNull(getLong(name), defaultValue);
@@ -113,7 +113,7 @@ default long getLong(String name, long defaultValue) {
    * Returns a {@link Double} configuration property.
    *
    * @return null if the property has not been configured
-   * @throws StructuredConfigException if the property is not a valid scalar double
+   * @throws DeclarativeConfigException if the property is not a valid scalar double
    */
   @Nullable
   Double getDouble(String name);
@@ -123,7 +123,7 @@ default long getLong(String name, long defaultValue) {
    *
    * @return a {@link Double} configuration property or {@code defaultValue} if a property with
    *     {@code name} has not been configured
-   * @throws StructuredConfigException if the property is not a valid scalar double
+   * @throws DeclarativeConfigException if the property is not a valid scalar double
    */
   default double getDouble(String name, double defaultValue) {
     return defaultIfNull(getDouble(name), defaultValue);
@@ -137,7 +137,7 @@ default double getDouble(String name, double defaultValue) {
    * @param scalarType the scalar type, one of {@link String}, {@link Boolean}, {@link Long} or
    *     {@link Double}
    * @return a {@link List} configuration property, or null if the property has not been configured
-   * @throws StructuredConfigException if the property is not a valid sequence of scalars, or if
+   * @throws DeclarativeConfigException if the property is not a valid sequence of scalars, or if
    *     {@code scalarType} is not supported
    */
   @Nullable
@@ -152,31 +152,31 @@ default double getDouble(String name, double defaultValue) {
    *     {@link Double}
    * @return a {@link List} configuration property or {@code defaultValue} if a property with {@code
    *     name} has not been configured
-   * @throws StructuredConfigException if the property is not a valid sequence of scalars
+   * @throws DeclarativeConfigException if the property is not a valid sequence of scalars
    */
   default <T> List<T> getScalarList(String name, Class<T> scalarType, List<T> defaultValue) {
     return defaultIfNull(getScalarList(name, scalarType), defaultValue);
   }
 
   /**
-   * Returns a {@link StructuredConfigProperties} configuration property.
+   * Returns a {@link DeclarativeConfigProperties} configuration property.
    *
    * @return a map-valued configuration property, or {@code null} if {@code name} has not been
    *     configured
-   * @throws StructuredConfigException if the property is not a mapping
+   * @throws DeclarativeConfigException if the property is not a mapping
    */
   @Nullable
-  StructuredConfigProperties getStructured(String name);
+  DeclarativeConfigProperties getStructured(String name);
 
   /**
-   * Returns a list of {@link StructuredConfigProperties} configuration property.
+   * Returns a list of {@link DeclarativeConfigProperties} configuration property.
    *
    * @return a list of map-valued configuration property, or {@code null} if {@code name} has not
    *     been configured
-   * @throws StructuredConfigException if the property is not a sequence of mappings
+   * @throws DeclarativeConfigException if the property is not a sequence of mappings
    */
   @Nullable
-  List<StructuredConfigProperties> getStructuredList(String name);
+  List<DeclarativeConfigProperties> getStructuredList(String name);
 
   /**
    * Returns a set of all configuration property keys.

api/incubator/src/main/java/io/opentelemetry/api/incubator/config/GlobalConfigProvider.java

@@ -10,8 +10,9 @@
 import javax.annotation.Nullable;
 
 /**
- * This class provides a temporary global accessor for {@link ConfigProvider} until the config API
- * is marked stable. It will eventually be merged into {@link GlobalOpenTelemetry}.
+ * This class provides a temporary global accessor for {@link ConfigProvider} until the
+ * instrumentation config API is marked stable. It will eventually be merged into {@link
+ * GlobalOpenTelemetry}.
  */
 // We intentionally assign to be used for error reporting.
 @SuppressWarnings("StaticAssignmentOfThrowable")

api/incubator/src/main/java/io/opentelemetry/api/incubator/config/InstrumentationConfigUtil.java

@@ -23,11 +23,11 @@ public class InstrumentationConfigUtil {
    * Return a map representation of the peer service map entries in {@code
    * .instrumentation.general.peer.service_mapping}, or null if none is configured.
    *
-   * @throws StructuredConfigException if an unexpected type is encountered accessing the property
+   * @throws DeclarativeConfigException if an unexpected type is encountered accessing the property
    */
   @Nullable
   public static Map<String, String> peerServiceMapping(ConfigProvider configProvider) {
-    Optional<List<StructuredConfigProperties>> optServiceMappingList =
+    Optional<List<DeclarativeConfigProperties>> optServiceMappingList =
         Optional.ofNullable(configProvider.getInstrumentationConfig())
             .map(instrumentationConfig -> instrumentationConfig.getStructured("general"))
             .map(generalConfig -> generalConfig.getStructured("peer"))
@@ -53,7 +53,7 @@ public static Map<String, String> peerServiceMapping(ConfigProvider configProvid
    * Return {@code .instrumentation.general.http.client.request_captured_headers}, or null if none
    * is configured.
    *
-   * @throws StructuredConfigException if an unexpected type is encountered accessing the property
+   * @throws DeclarativeConfigException if an unexpected type is encountered accessing the property
    */
   @Nullable
   public static List<String> httpClientRequestCapturedHeaders(ConfigProvider configProvider) {
@@ -70,7 +70,7 @@ public static List<String> httpClientRequestCapturedHeaders(ConfigProvider confi
    * Return {@code .instrumentation.general.http.client.response_captured_headers}, or null if none
    * is configured.
    *
-   * @throws StructuredConfigException if an unexpected type is encountered accessing the property
+   * @throws DeclarativeConfigException if an unexpected type is encountered accessing the property
    */
   @Nullable
   public static List<String> httpClientResponseCapturedHeaders(ConfigProvider configProvider) {
@@ -87,7 +87,7 @@ public static List<String> httpClientResponseCapturedHeaders(ConfigProvider conf
    * Return {@code .instrumentation.general.http.server.request_captured_headers}, or null if none
    * is configured.
    *
-   * @throws StructuredConfigException if an unexpected type is encountered accessing the property
+   * @throws DeclarativeConfigException if an unexpected type is encountered accessing the property
    */
   @Nullable
   public static List<String> httpServerRequestCapturedHeaders(ConfigProvider configProvider) {
@@ -104,7 +104,7 @@ public static List<String> httpServerRequestCapturedHeaders(ConfigProvider confi
    * Return {@code .instrumentation.general.http.server.response_captured_headers}, or null if none
    * is configured.
    *
-   * @throws StructuredConfigException if an unexpected type is encountered accessing the property
+   * @throws DeclarativeConfigException if an unexpected type is encountered accessing the property
    */
   @Nullable
   public static List<String> httpSeverResponseCapturedHeaders(ConfigProvider configProvider) {
@@ -120,10 +120,10 @@ public static List<String> httpSeverResponseCapturedHeaders(ConfigProvider confi
   /**
    * Return {@code .instrumentation.java.<instrumentationName>}, or null if none is configured.
    *
-   * @throws StructuredConfigException if an unexpected type is encountered accessing the property
+   * @throws DeclarativeConfigException if an unexpected type is encountered accessing the property
    */
   @Nullable
-  public static StructuredConfigProperties javaInstrumentationConfig(
+  public static DeclarativeConfigProperties javaInstrumentationConfig(
       ConfigProvider configProvider, String instrumentationName) {
     return Optional.ofNullable(configProvider.getInstrumentationConfig())
         .map(instrumentationConfig -> instrumentationConfig.getStructured("java"))