Skip to content

add declarative config for baggage #2031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
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
8 changes: 8 additions & 0 deletions baggage-processor/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,19 @@ description = "OpenTelemetry Baggage Span Processor"
otelJava.moduleName.set("io.opentelemetry.contrib.baggage.processor")

dependencies {
annotationProcessor("com.google.auto.service:auto-service")
compileOnly("com.google.auto.service:auto-service-annotations")
api("io.opentelemetry:opentelemetry-api")
api("io.opentelemetry:opentelemetry-sdk")
implementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi")
compileOnly("io.opentelemetry:opentelemetry-sdk-common")
compileOnly("io.opentelemetry:opentelemetry-sdk-extension-incubator")
Comment on lines +16 to +17
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what's the reason for compileOnly vs implementation?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the auto configuration is optional - programmatic config should not pull unneeded deps


testAnnotationProcessor("com.google.auto.service:auto-service")
testCompileOnly("com.google.auto.service:auto-service-annotations")
testImplementation("io.opentelemetry:opentelemetry-sdk-common")
testImplementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
testImplementation("io.opentelemetry:opentelemetry-sdk-extension-incubator")
testImplementation("io.opentelemetry:opentelemetry-sdk-testing")
testImplementation("org.mockito:mockito-inline")
testImplementation("com.google.guava:guava")
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.contrib.baggage.processor;

import com.google.auto.service.AutoService;
import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
import io.opentelemetry.sdk.internal.IncludeExcludePredicate;
import io.opentelemetry.sdk.logs.LogRecordProcessor;

@SuppressWarnings("rawtypes")
@AutoService(ComponentProvider.class)
public class BaggageLogRecordComponentProvider implements ComponentProvider<LogRecordProcessor> {
@Override
public String getName() {
return "baggage";
}

@Override
public LogRecordProcessor create(DeclarativeConfigProperties config) {
return new BaggageLogRecordProcessor(
IncludeExcludePredicate.createPatternMatching(
config.getScalarList("included", String.class),
config.getScalarList("excluded", String.class)));
}

@Override
public Class<LogRecordProcessor> getType() {
return LogRecordProcessor.class;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@

package io.opentelemetry.contrib.baggage.processor;

import com.google.auto.service.AutoService;
import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer;
import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider;
import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
import io.opentelemetry.sdk.logs.SdkLoggerProviderBuilder;
import io.opentelemetry.sdk.trace.SdkTracerProviderBuilder;
import java.util.List;

@AutoService(AutoConfigurationCustomizerProvider.class)
public class BaggageProcessorCustomizer implements AutoConfigurationCustomizerProvider {
@Override
public void customize(AutoConfigurationCustomizer autoConfigurationCustomizer) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.contrib.baggage.processor;

import com.google.auto.service.AutoService;
import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
import io.opentelemetry.sdk.internal.IncludeExcludePredicate;
import io.opentelemetry.sdk.trace.SpanProcessor;

@SuppressWarnings("rawtypes")
@AutoService(ComponentProvider.class)
public class BaggageSpanComponentProvider implements ComponentProvider<SpanProcessor> {
@Override
public String getName() {
return "baggage";
}

@Override
public SpanProcessor create(DeclarativeConfigProperties config) {
return new BaggageSpanProcessor(
IncludeExcludePredicate.createPatternMatching(
config.getScalarList("included", String.class),
config.getScalarList("excluded", String.class)));
}

@Override
public Class<SpanProcessor> getType() {
return SpanProcessor.class;
}
}

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.contrib.baggage.processor;

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

import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfiguration;
import java.io.ByteArrayInputStream;
import java.nio.charset.StandardCharsets;
import org.junit.jupiter.api.Test;

class BaggageLogRecordComponentProviderTest {

@Test
void declarativeConfig() {
String yaml =
"file_format: 0.4\n"
+ "logger_provider:\n"
+ " processors:\n"
+ " - baggage:\n"
+ " included: [foo]\n"
+ " excluded: [bar]\n";

OpenTelemetrySdk sdk =
DeclarativeConfiguration.parseAndCreate(
new ByteArrayInputStream(yaml.getBytes(StandardCharsets.UTF_8)));

assertThat(sdk).asString().contains("BaggageLogRecordProcessor");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,15 @@ class BaggageProcessorCustomizerTest {
private static final String MEMORY_EXPORTER = "memory";

@Test
void test_customizer() {
void test_empty_customizer() {
assertCustomizer(
Collections.emptyMap(),
span -> assertThat(span).hasTotalAttributeCount(0),
logRecord -> assertThat(logRecord).hasTotalAttributeCount(0));
}

@Test
void test_customizer() {
Map<String, String> properties = new HashMap<>();
properties.put("otel.java.experimental.span-attributes.copy-from-baggage.include", "key");
properties.put("otel.java.experimental.log-attributes.copy-from-baggage.include", "key");
Expand Down Expand Up @@ -117,7 +121,7 @@ private static OpenTelemetrySdk getOpenTelemetrySdk(
new ComponentLoader() {
@Override
public <T> List<T> load(Class<T> spiClass) {
if (spiClass == ConfigurableSpanExporterProvider.class) {
if (spiClass.equals(ConfigurableSpanExporterProvider.class)) {
return Collections.singletonList(
spiClass.cast(
new ConfigurableSpanExporterProvider() {
Expand All @@ -132,7 +136,7 @@ public String getName() {
return MEMORY_EXPORTER;
}
}));
} else if (spiClass == ConfigurableLogRecordExporterProvider.class) {
} else if (spiClass.equals(ConfigurableLogRecordExporterProvider.class)) {
return Collections.singletonList(
spiClass.cast(
new ConfigurableLogRecordExporterProvider() {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.contrib.baggage.processor;

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

import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfiguration;
import java.io.ByteArrayInputStream;
import java.nio.charset.StandardCharsets;
import org.junit.jupiter.api.Test;

class BaggageSpanComponentProviderTest {

@Test
void declarativeConfig() {
String yaml =
"file_format: 0.4\n"
+ "tracer_provider:\n"
+ " processors:\n"
+ " - baggage:\n"
+ " included: [foo]\n"
+ " excluded: [bar]\n";

OpenTelemetrySdk sdk =
DeclarativeConfiguration.parseAndCreate(
new ByteArrayInputStream(yaml.getBytes(StandardCharsets.UTF_8)));

assertThat(sdk).asString().contains("BaggageSpanProcessor");
}
}
Loading