Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions integration-tests/osgi/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,7 @@ val autoconfigureDeclarativeConfigSuiteTask = registerOsgiSuite(
implementation(project(":sdk:all"))
implementation(project(":sdk-extensions:autoconfigure"))
implementation(project(":sdk-extensions:declarative-config"))
implementation(project(":api:incubator"))
implementation(project(":exporters:otlp:all"))
implementation(project(":extensions:trace-propagators"))
runtimeOnly(project(":exporters:sender:jdk"))
Expand Down
2 changes: 2 additions & 0 deletions sdk-extensions/autoconfigure/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ testing {
register<JvmTestSuite>("testIncubating") {
dependencies {
implementation(project(":sdk-extensions:declarative-config"))
implementation(project(":api:incubator"))
implementation(project(":exporters:logging"))
implementation(project(":exporters:otlp:all"))
implementation(project(":sdk:testing"))
Expand All @@ -120,6 +121,7 @@ testing {
register<JvmTestSuite>("testDeclarativeConfigSpi") {
dependencies {
implementation(project(":sdk-extensions:declarative-config"))
implementation(project(":api:incubator"))
implementation(project(":exporters:logging"))
implementation(project(":sdk:testing"))
}
Expand Down
2 changes: 1 addition & 1 deletion sdk-extensions/declarative-config/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ otelJava.osgiServiceLoaderRequires.set(listOf(

dependencies {
api(project(":sdk:all"))
api(project(":api:incubator"))
implementation(project(":api:incubator"))
compileOnly(project(":sdk-extensions:autoconfigure-spi"))
runtimeOnly(project(":sdk-extensions:declarative-config-jackson2"))
runtimeOnly(project(":sdk-extensions:declarative-config-snakeyaml-engine2"))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,22 @@

package io.opentelemetry.sdk.autoconfigure.declarativeconfig;

import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.OpenTelemetryConfigurationModel;
import io.opentelemetry.sdk.internal.ExtendedOpenTelemetrySdk;
import io.opentelemetry.sdk.resources.Resource;

/** The result of {@link DeclarativeConfiguration#create(OpenTelemetryConfigurationModel)}. */
public final class DeclarativeConfigResult {

private final ExtendedOpenTelemetrySdk sdk;
private final OpenTelemetrySdk sdk;
private final Resource resource;

DeclarativeConfigResult(ExtendedOpenTelemetrySdk sdk, Resource resource) {
DeclarativeConfigResult(OpenTelemetrySdk sdk, Resource resource) {
this.sdk = sdk;
this.resource = resource;
}

public ExtendedOpenTelemetrySdk getSdk() {
public OpenTelemetrySdk getSdk() {
return sdk;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.OpenTelemetryConfigurationModel;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.SpanProcessorModel;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.TracerProviderModel;
import io.opentelemetry.sdk.internal.ExtendedOpenTelemetrySdk;
import io.opentelemetry.sdk.resources.ResourceBuilder;
import io.opentelemetry.sdk.trace.samplers.ParentBasedSamplerBuilder;
import java.io.ByteArrayInputStream;
Expand Down Expand Up @@ -181,7 +180,7 @@ void create_ModelCustomizer() {
.setProcessors(
Collections.singletonList(
new SpanProcessorModel().setExtensionProperty("test", null))));
ExtendedOpenTelemetrySdk sdk =
OpenTelemetrySdk sdk =
DeclarativeConfiguration.create(
model,
// customizer is TestDeclarativeConfigurationCustomizerProvider
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.internal.ExperimentalResourceDetectionModel;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.internal.ExperimentalResourceDetectorModel;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.internal.ResourceModelAccessor;
import io.opentelemetry.sdk.internal.ExtendedOpenTelemetrySdk;
import io.opentelemetry.sdk.internal.OpenTelemetrySdkBuilderUtil;
import io.opentelemetry.sdk.internal.SdkConfigProvider;
import io.opentelemetry.sdk.logs.LogLimits;
Expand Down Expand Up @@ -147,7 +146,7 @@ void create_FileFormatVersionMismatch_LogsWarning() {
OpenTelemetryConfigurationModel model =
new OpenTelemetryConfigurationModel().setFileFormat("1.0-rc.3");

ExtendedOpenTelemetrySdk sdk =
OpenTelemetrySdk sdk =
OpenTelemetryConfigurationFactory.getInstance().create(model, context).getSdk();
cleanup.addCloseable(sdk);

Expand All @@ -160,7 +159,7 @@ void create_FileFormatExactMatch_NoWarning() {
OpenTelemetryConfigurationModel model =
new OpenTelemetryConfigurationModel().setFileFormat("1.2");

ExtendedOpenTelemetrySdk sdk =
OpenTelemetrySdk sdk =
OpenTelemetryConfigurationFactory.getInstance().create(model, context).getSdk();
cleanup.addCloseable(sdk);

Expand All @@ -179,7 +178,7 @@ void create_Defaults() {
.build();
cleanup.addCloseable(expectedSdk);

ExtendedOpenTelemetrySdk sdk =
OpenTelemetrySdk sdk =
OpenTelemetryConfigurationFactory.getInstance().create(model, context).getSdk();
cleanup.addCloseable(sdk);
cleanup.addCloseables(closeables);
Expand Down Expand Up @@ -212,7 +211,7 @@ void create_Disabled() {
.build();
cleanup.addCloseable(expectedSdk);

ExtendedOpenTelemetrySdk sdk =
OpenTelemetrySdk sdk =
OpenTelemetryConfigurationFactory.getInstance().create(model, context).getSdk();
cleanup.addCloseable(sdk);
cleanup.addCloseables(closeables);
Expand Down Expand Up @@ -372,7 +371,7 @@ void create_Configured() throws NoSuchFieldException {

cleanup.addCloseable(expectedSdk);

ExtendedOpenTelemetrySdk sdk =
OpenTelemetrySdk sdk =
OpenTelemetryConfigurationFactory.getInstance().create(model, context).getSdk();
cleanup.addCloseable(sdk);
cleanup.addCloseables(closeables);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.sdk.autoconfigure.declarativeconfig;

import static org.assertj.core.api.Assertions.assertThat;

import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.OpenTelemetryConfigurationModel;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.ResourceModel;
import io.opentelemetry.sdk.resources.Resource;
import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import org.junit.jupiter.api.Test;

/**
* Validates that an external consumer can parse, inspect, customize, and create an {@link
* OpenTelemetrySdk} strictly using the public declarative configuration API surface without
* importing or relying on any incubator or internal packages.
*/
class PublicApiUsageTest {

private static final String MINIMAL_CONFIG =
"file_format: \"1.2\"\n"
+ "resource:\n"
+ " attributes:\n"
+ " - name: service.name\n"
+ " value: test-service\n";

@Test
void parseAndCreate_endToEndPublicApiWorkflow() {
InputStream inputStream =
new ByteArrayInputStream(MINIMAL_CONFIG.getBytes(StandardCharsets.UTF_8));

// 1. Parse configuration strictly via public API
OpenTelemetryConfigurationModel model = DeclarativeConfiguration.parse(inputStream);
assertThat(model).isNotNull();
assertThat(model.getFileFormat()).isEqualTo("1.2");

// 2. Inspect and customize model using only public model methods
ResourceModel resourceModel = model.getResource();
assertThat(resourceModel).isNotNull();

// 3. Create SDK via DeclarativeConfiguration.create(model)
DeclarativeConfigResult result = DeclarativeConfiguration.create(model);
assertThat(result).isNotNull();

Resource resource = result.getResource();
assertThat(resource.getAttribute(AttributeKey.stringKey("service.name")))
.isEqualTo("test-service");

OpenTelemetrySdk sdk = result.getSdk();
assertThat(sdk).isNotNull();
try {
Tracer tracer = sdk.getTracer("test-tracer");
assertThat(tracer).isNotNull();
} finally {
sdk.close();
}
}

@Test
void parseAndCreate_convenienceMethod() {
InputStream inputStream =
new ByteArrayInputStream(MINIMAL_CONFIG.getBytes(StandardCharsets.UTF_8));

DeclarativeConfigResult result = DeclarativeConfiguration.parseAndCreate(inputStream);
assertThat(result).isNotNull();

OpenTelemetrySdk sdk = result.getSdk();
assertThat(sdk).isNotNull();
try {
assertThat(result.getResource().getAttribute(AttributeKey.stringKey("service.name")))
.isEqualTo("test-service");
} finally {
sdk.close();
}
}
}
Loading