This class is internal and is hence not for public use. Its APIs are unstable and can change * at any time. diff --git a/exporters/logging-otlp/src/main/java/io/opentelemetry/exporter/logging/otlp/internal/metrics/OtlpStdoutMetricExporterComponentProvider.java b/exporters/logging-otlp/src/main/java/io/opentelemetry/exporter/logging/otlp/internal/metrics/OtlpStdoutMetricExporterComponentProvider.java index e1e2dc88153..2a69bd0c7d1 100644 --- a/exporters/logging-otlp/src/main/java/io/opentelemetry/exporter/logging/otlp/internal/metrics/OtlpStdoutMetricExporterComponentProvider.java +++ b/exporters/logging-otlp/src/main/java/io/opentelemetry/exporter/logging/otlp/internal/metrics/OtlpStdoutMetricExporterComponentProvider.java @@ -11,7 +11,7 @@ import io.opentelemetry.sdk.metrics.export.MetricExporter; /** - * File configuration SPI implementation for {@link OtlpStdoutMetricExporter}. + * Declarative configuration SPI implementation for {@link OtlpStdoutMetricExporter}. * *
This class is internal and is hence not for public use. Its APIs are unstable and can change * at any time. diff --git a/exporters/logging-otlp/src/main/java/io/opentelemetry/exporter/logging/otlp/internal/traces/OtlpStdoutSpanExporterComponentProvider.java b/exporters/logging-otlp/src/main/java/io/opentelemetry/exporter/logging/otlp/internal/traces/OtlpStdoutSpanExporterComponentProvider.java index af299c16251..c21029ed133 100644 --- a/exporters/logging-otlp/src/main/java/io/opentelemetry/exporter/logging/otlp/internal/traces/OtlpStdoutSpanExporterComponentProvider.java +++ b/exporters/logging-otlp/src/main/java/io/opentelemetry/exporter/logging/otlp/internal/traces/OtlpStdoutSpanExporterComponentProvider.java @@ -11,7 +11,7 @@ import io.opentelemetry.sdk.trace.export.SpanExporter; /** - * File configuration SPI implementation for {@link OtlpStdoutSpanExporter}. + * Declarative configuration SPI implementation for {@link OtlpStdoutSpanExporter}. * *
This class is internal and is hence not for public use. Its APIs are unstable and can change * at any time. diff --git a/exporters/logging/src/main/java/io/opentelemetry/exporter/logging/internal/ConsoleLogRecordExporterComponentProvider.java b/exporters/logging/src/main/java/io/opentelemetry/exporter/logging/internal/ConsoleLogRecordExporterComponentProvider.java index 4d03480b335..8c9d048c3b0 100644 --- a/exporters/logging/src/main/java/io/opentelemetry/exporter/logging/internal/ConsoleLogRecordExporterComponentProvider.java +++ b/exporters/logging/src/main/java/io/opentelemetry/exporter/logging/internal/ConsoleLogRecordExporterComponentProvider.java @@ -11,7 +11,7 @@ import io.opentelemetry.sdk.logs.export.LogRecordExporter; /** - * File configuration SPI implementation for {@link SystemOutLogRecordExporter}. + * Declarative configuration SPI implementation for {@link SystemOutLogRecordExporter}. * *
This class is internal and is hence not for public use. Its APIs are unstable and can change * at any time. diff --git a/exporters/logging/src/main/java/io/opentelemetry/exporter/logging/internal/ConsoleMetricExporterComponentProvider.java b/exporters/logging/src/main/java/io/opentelemetry/exporter/logging/internal/ConsoleMetricExporterComponentProvider.java index 48a449ff0f0..df5270ca11a 100644 --- a/exporters/logging/src/main/java/io/opentelemetry/exporter/logging/internal/ConsoleMetricExporterComponentProvider.java +++ b/exporters/logging/src/main/java/io/opentelemetry/exporter/logging/internal/ConsoleMetricExporterComponentProvider.java @@ -11,7 +11,7 @@ import io.opentelemetry.sdk.metrics.export.MetricExporter; /** - * File configuration SPI implementation for {@link LoggingMetricExporter}. + * Declarative configuration SPI implementation for {@link LoggingMetricExporter}. * *
This class is internal and is hence not for public use. Its APIs are unstable and can change * at any time. diff --git a/exporters/logging/src/main/java/io/opentelemetry/exporter/logging/internal/ConsoleSpanExporterComponentProvider.java b/exporters/logging/src/main/java/io/opentelemetry/exporter/logging/internal/ConsoleSpanExporterComponentProvider.java index c212a77d5d4..a6fa1950bdf 100644 --- a/exporters/logging/src/main/java/io/opentelemetry/exporter/logging/internal/ConsoleSpanExporterComponentProvider.java +++ b/exporters/logging/src/main/java/io/opentelemetry/exporter/logging/internal/ConsoleSpanExporterComponentProvider.java @@ -11,7 +11,7 @@ import io.opentelemetry.sdk.trace.export.SpanExporter; /** - * File configuration SPI implementation for {@link LoggingSpanExporter}. + * Declarative configuration SPI implementation for {@link LoggingSpanExporter}. * *
This class is internal and is hence not for public use. Its APIs are unstable and can change * at any time. diff --git a/exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/internal/OtlpLogRecordExporterComponentProvider.java b/exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/internal/OtlpLogRecordExporterComponentProvider.java index cd7d97a1d46..9134976e495 100644 --- a/exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/internal/OtlpLogRecordExporterComponentProvider.java +++ b/exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/internal/OtlpLogRecordExporterComponentProvider.java @@ -19,7 +19,7 @@ import io.opentelemetry.sdk.logs.export.LogRecordExporter; /** - * File configuration SPI implementation for {@link OtlpHttpLogRecordExporter} and {@link + * Declarative configuration SPI implementation for {@link OtlpHttpLogRecordExporter} and {@link * OtlpGrpcLogRecordExporter}. * *
This class is internal and is hence not for public use. Its APIs are unstable and can change diff --git a/exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/internal/OtlpMetricExporterComponentProvider.java b/exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/internal/OtlpMetricExporterComponentProvider.java index 2bbec38c533..a08cab883b1 100644 --- a/exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/internal/OtlpMetricExporterComponentProvider.java +++ b/exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/internal/OtlpMetricExporterComponentProvider.java @@ -20,7 +20,7 @@ import io.opentelemetry.sdk.metrics.export.MetricExporter; /** - * File configuration SPI implementation for {@link OtlpHttpMetricExporter} and {@link + * Declarative configuration SPI implementation for {@link OtlpHttpMetricExporter} and {@link * OtlpGrpcMetricExporter}. * *
This class is internal and is hence not for public use. Its APIs are unstable and can change diff --git a/exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/internal/OtlpSpanExporterComponentProvider.java b/exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/internal/OtlpSpanExporterComponentProvider.java index 707ff0c4383..1f84115b252 100644 --- a/exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/internal/OtlpSpanExporterComponentProvider.java +++ b/exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/internal/OtlpSpanExporterComponentProvider.java @@ -19,7 +19,7 @@ import io.opentelemetry.sdk.trace.export.SpanExporter; /** - * File configuration SPI implementation for {@link OtlpHttpSpanExporter} and {@link + * Declarative configuration SPI implementation for {@link OtlpHttpSpanExporter} and {@link * OtlpGrpcSpanExporter}. * *
This class is internal and is hence not for public use. Its APIs are unstable and can change diff --git a/exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/internal/PrometheusComponentProvider.java b/exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/internal/PrometheusComponentProvider.java index dc57d2bcbe3..7599619a3a5 100644 --- a/exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/internal/PrometheusComponentProvider.java +++ b/exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/internal/PrometheusComponentProvider.java @@ -12,7 +12,7 @@ import io.opentelemetry.sdk.metrics.export.MetricReader; /** - * File configuration SPI implementation for {@link PrometheusHttpServer}. + * Declarative configuration SPI implementation for {@link PrometheusHttpServer}. * *
This class is internal and is hence not for public use. Its APIs are unstable and can change * at any time. diff --git a/exporters/zipkin/src/main/java/io/opentelemetry/exporter/zipkin/internal/ZipkinSpanExporterComponentProvider.java b/exporters/zipkin/src/main/java/io/opentelemetry/exporter/zipkin/internal/ZipkinSpanExporterComponentProvider.java index eafd62479f0..f539a8ecde6 100644 --- a/exporters/zipkin/src/main/java/io/opentelemetry/exporter/zipkin/internal/ZipkinSpanExporterComponentProvider.java +++ b/exporters/zipkin/src/main/java/io/opentelemetry/exporter/zipkin/internal/ZipkinSpanExporterComponentProvider.java @@ -13,7 +13,7 @@ import java.time.Duration; /** - * File configuration SPI implementation for {@link ZipkinSpanExporter}. + * Declarative configuration SPI implementation for {@link ZipkinSpanExporter}. * *
This class is internal and is hence not for public use. Its APIs are unstable and can change * at any time. diff --git a/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/B3ComponentProvider.java b/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/B3ComponentProvider.java index b97134eda7a..ba42a1fd07e 100644 --- a/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/B3ComponentProvider.java +++ b/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/B3ComponentProvider.java @@ -11,8 +11,8 @@ import io.opentelemetry.sdk.autoconfigure.spi.internal.StructuredConfigProperties; /** - * File configuration SPI implementation for {@link B3Propagator} which allows enables the {@link - * B3Propagator#injectingSingleHeader()}. + * Declarative configuration SPI implementation for {@link B3Propagator} which allows enables the + * {@link B3Propagator#injectingSingleHeader()}. * *
This class is internal and is hence not for public use. Its APIs are unstable and can change * at any time. diff --git a/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/B3MultiComponentProvider.java b/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/B3MultiComponentProvider.java index 77ac501a2ea..a95e195621c 100644 --- a/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/B3MultiComponentProvider.java +++ b/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/B3MultiComponentProvider.java @@ -11,8 +11,8 @@ import io.opentelemetry.sdk.autoconfigure.spi.internal.StructuredConfigProperties; /** - * File configuration SPI implementation for {@link B3Propagator} which allows enables the {@link - * B3Propagator#injectingMultiHeaders()}. + * Declarative configuration SPI implementation for {@link B3Propagator} which allows enables the + * {@link B3Propagator#injectingMultiHeaders()}. * *
This class is internal and is hence not for public use. Its APIs are unstable and can change * at any time. diff --git a/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/JaegerComponentProvider.java b/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/JaegerComponentProvider.java index 0fb844a40da..d3e3111b3fd 100644 --- a/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/JaegerComponentProvider.java +++ b/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/JaegerComponentProvider.java @@ -11,7 +11,7 @@ import io.opentelemetry.sdk.autoconfigure.spi.internal.StructuredConfigProperties; /** - * File configuration SPI implementation for {@link JaegerPropagator}. + * Declarative configuration SPI implementation for {@link JaegerPropagator}. * *
This class is internal and is hence not for public use. Its APIs are unstable and can change * at any time. diff --git a/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/OtTraceComponentProvider.java b/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/OtTraceComponentProvider.java index 97b41aad3af..3e4f978f626 100644 --- a/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/OtTraceComponentProvider.java +++ b/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/OtTraceComponentProvider.java @@ -12,7 +12,7 @@ import io.opentelemetry.sdk.autoconfigure.spi.internal.StructuredConfigProperties; /** - * File configuration SPI implementation for {@link B3Propagator}. + * Declarative configuration SPI implementation for {@link B3Propagator}. * *
This class is internal and is hence not for public use. Its APIs are unstable and can change * at any time. diff --git a/sdk-extensions/autoconfigure-spi/src/main/java/io/opentelemetry/sdk/autoconfigure/spi/internal/ComponentProvider.java b/sdk-extensions/autoconfigure-spi/src/main/java/io/opentelemetry/sdk/autoconfigure/spi/internal/ComponentProvider.java index 335c9a7c0ab..b7f93b615db 100644 --- a/sdk-extensions/autoconfigure-spi/src/main/java/io/opentelemetry/sdk/autoconfigure/spi/internal/ComponentProvider.java +++ b/sdk-extensions/autoconfigure-spi/src/main/java/io/opentelemetry/sdk/autoconfigure/spi/internal/ComponentProvider.java @@ -16,7 +16,7 @@ /** * Provides configured instances of SDK extension components. {@link ComponentProvider} allows SDK - * extension components which are not part of the core SDK to be referenced in file based + * extension components which are not part of the core SDK to be referenced in declarative based * configuration. * *
NOTE: when {@link #getType()} is {@link Resource}, the {@link #getName()} is not (currently) diff --git a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdk.java b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdk.java index 6751da7ad7f..666da0f89c7 100644 --- a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdk.java +++ b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdk.java @@ -67,8 +67,8 @@ static AutoConfiguredOpenTelemetrySdk create( abstract Resource getResource(); /** - * Returns the {@link ConfigProperties} used for auto-configuration, or {@code null} if file - * configuration was used. + * Returns the {@link ConfigProperties} used for auto-configuration, or {@code null} if + * declarative configuration was used. * * @see #getStructuredConfig() */ @@ -77,7 +77,7 @@ static AutoConfiguredOpenTelemetrySdk create( /** * Returns the {@link StructuredConfigProperties} used for auto-configuration, or {@code null} if - * file configuration was not used. + * declarative configuration was not used. * * @see #getConfig() */ diff --git a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdkBuilder.java b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdkBuilder.java index 030045ea52d..995417b8fd7 100644 --- a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdkBuilder.java +++ b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdkBuilder.java @@ -563,7 +563,7 @@ private static AutoConfiguredOpenTelemetrySdk maybeConfigureFromFile( configurationFactory.getMethod("toConfigProperties", openTelemetryConfiguration); StructuredConfigProperties structuredConfigProperties = (StructuredConfigProperties) toConfigProperties.invoke(null, model); - // Note: can't access file configuration resource without reflection so setting a dummy + // Note: can't access declarative configuration resource without reflection so setting a dummy // resource return AutoConfiguredOpenTelemetrySdk.create( sdk, Resource.getDefault(), null, structuredConfigProperties); diff --git a/sdk-extensions/incubator/README.md b/sdk-extensions/incubator/README.md index abdb90cf9a7..1938182c9e3 100644 --- a/sdk-extensions/incubator/README.md +++ b/sdk-extensions/incubator/README.md @@ -2,9 +2,9 @@ This artifact contains experimental code related to the trace and metric SDKs. -## File Configuration +## Declarative Configuration -Allows for YAML based file configuration of `OpenTelemetrySdk` as defined in the [specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/data-model.md#file-based-configuration-model). +The [declarative configuration interface](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/README.md#declarative-configuration) allows for YAML based file configuration of `OpenTelemetrySdk`. Usage: @@ -19,8 +19,17 @@ try (FileInputStream yamlConfigFileInputStream = new FileInputStream("/path/to/c Notes: * Environment variable substitution is supported as [defined in the spec](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/data-model.md#environment-variable-substitution) -* Currently, there is no support for the SPIs defined in [opentelemetry-sdk-extension-autoconfigure-spi](../autoconfigure-spi). Only built in samplers, processors, exporters, etc can be configured. -* You can use file configuration with [autoconfigure](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure#file-configuration) to specify a configuration file via environment variable, e.g. `OTEL_EXPERIMENTAL_CONFIG_FILE=/path/to/config.yaml`. +* Currently, there is no support for the customization (i.e. `AutoConfigurationCustomizerProvider`) SPIs defined in [opentelemetry-sdk-extension-autoconfigure-spi](../autoconfigure-spi). +* Custom SDK extension components which reference the [ComponentProvider](https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure-spi/src/main/java/io/opentelemetry/sdk/autoconfigure/spi/internal/ComponentProvider.java) SPI can be referenced in declarative configuration. Supported types include: + * `Resource` + * `SpanExporter` + * `MetricExporter` + * `LogRecordExporter` + * `SpanProcessor` + * `LogRecordProcessor` + * `TextMapPropagator` + * `Sampler` +* You can use declarative configuration with [autoconfigure](https://opentelemetry.io/docs/languages/java/configuration/#declarative-configuration) to specify a configuration file via environment variable, e.g. `OTEL_EXPERIMENTAL_CONFIG_FILE=/path/to/config.yaml`. ## View File Configuration diff --git a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/ResourceFactory.java b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/ResourceFactory.java index 8f26e6a47e7..0f3a8164c9f 100644 --- a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/ResourceFactory.java +++ b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/ResourceFactory.java @@ -88,7 +88,7 @@ public Resource create( /** * Load resources from resource detectors, in order of lowest priority to highest priority. * - *
In file configuration, a resource detector is a {@link ComponentProvider} with {@link + *
In declarative configuration, a resource detector is a {@link ComponentProvider} with {@link * ComponentProvider#getType()} set to {@link Resource}. Unlike other {@link ComponentProvider}s, * the resource detector version does not use {@link ComponentProvider#getName()} (except for * debug messages), and {@link ComponentProvider#create(StructuredConfigProperties)} is called diff --git a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/YamlStructuredConfigProperties.java b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/YamlStructuredConfigProperties.java index 87cbc5f8fc8..f302ee5c805 100644 --- a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/YamlStructuredConfigProperties.java +++ b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/YamlStructuredConfigProperties.java @@ -24,12 +24,13 @@ import javax.annotation.Nullable; /** - * Implementation of {@link StructuredConfigProperties} which uses a file configuration model as a - * source. + * Implementation of {@link StructuredConfigProperties} which uses a declarative configuration model + * as a source. * * @see #getStructured(String) Accessing nested maps * @see #getStructuredList(String) Accessing lists of maps - * @see FileConfiguration#toConfigProperties(Object) Converting configuration model to properties + * @see FileConfiguration#toConfigProperties(Object, ComponentLoader) Converting configuration model + * to properties */ final class YamlStructuredConfigProperties implements StructuredConfigProperties { diff --git a/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/YamlStructuredConfigPropertiesTest.java b/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/YamlStructuredConfigPropertiesTest.java index 25f9a877c95..3bbd11bcef5 100644 --- a/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/YamlStructuredConfigPropertiesTest.java +++ b/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/YamlStructuredConfigPropertiesTest.java @@ -68,7 +68,7 @@ void setup() { @Test void configurationSchema() { - // Validate can read file configuration schema properties + // Validate can read declarative configuration schema properties assertThat(structuredConfigProps.getString("file_format")).isEqualTo("0.3"); StructuredConfigProperties resourceProps = structuredConfigProps.getStructured("resource"); assertThat(resourceProps).isNotNull();