Skip to content

Extra-Content-Type header added for declarative config #3138

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.

Sign up for GitHub

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

Closed
robsunday wants to merge 1 commit into from
Closed

Extra-Content-Type header added for declarative config #3138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
60 changes: 49 additions & 11 deletions profiler/src/main/java/com/splunk/opentelemetry/profiler/LogExporterBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@
import com.splunk.opentelemetry.profiler.util.DeclarativeConfigPropertiesUtil;
import io.opentelemetry.api.incubator.config.ConfigProvider;
import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
import io.opentelemetry.api.metrics.MeterProvider;
import io.opentelemetry.common.ComponentLoader;
import io.opentelemetry.exporter.otlp.http.logs.OtlpHttpLogRecordExporter;
import io.opentelemetry.exporter.otlp.http.logs.OtlpHttpLogRecordExporterBuilder;
import io.opentelemetry.exporter.otlp.internal.OtlpConfigUtil;
import io.opentelemetry.exporter.otlp.internal.OtlpGrpcLogRecordExporterComponentProvider;
import io.opentelemetry.exporter.otlp.internal.OtlpHttpLogRecordExporterComponentProvider;
import io.opentelemetry.exporter.otlp.internal.OtlpDeclarativeConfigUtil;
import io.opentelemetry.exporter.otlp.logs.OtlpGrpcLogRecordExporter;
import io.opentelemetry.exporter.otlp.logs.OtlpGrpcLogRecordExporterBuilder;
import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
Expand All @@ -53,27 +53,21 @@ static LogRecordExporter fromDeclarativeConfig(
Set<String> propertyKeys = exporterConfigProperties.getPropertyKeys();
if (propertyKeys.isEmpty()) {
DeclarativeConfigProperties otlpHttp = defaultOtlpHttpConfig(exporterConfigProperties);
OtlpHttpLogRecordExporterComponentProvider provider =
new OtlpHttpLogRecordExporterComponentProvider();
return provider.create(toExtended(otlpHttp));
return buildDeclarativeHttpExporter(otlpHttp);
}

if (propertyKeys.contains("otlp_log_http")) {
DeclarativeConfigProperties otlpHttp =
DeclarativeConfigPropertiesUtil.getStructuredOrEmpty(
exporterConfigProperties, "otlp_log_http");
OtlpHttpLogRecordExporterComponentProvider provider =
new OtlpHttpLogRecordExporterComponentProvider();
return provider.create(toExtended(otlpHttp));
return buildDeclarativeHttpExporter(otlpHttp);
}

if (propertyKeys.contains("otlp_log_grpc")) {
DeclarativeConfigProperties otlpGrpc =
DeclarativeConfigPropertiesUtil.getStructuredOrEmpty(
exporterConfigProperties, "otlp_log_grpc");
OtlpGrpcLogRecordExporterComponentProvider provider =
new OtlpGrpcLogRecordExporterComponentProvider();
return provider.create(toExtended(otlpGrpc));
return buildDeclarativeGrpcExporter(otlpGrpc);
}
}

Expand All @@ -89,6 +83,50 @@ private static DeclarativeConfigProperties defaultOtlpHttpConfig(
exporterConfigProperties, properties);
}

private static LogRecordExporter buildDeclarativeHttpExporter(
DeclarativeConfigProperties config) {
OtlpHttpLogRecordExporterBuilder builder = OtlpHttpLogRecordExporter.builder();
OtlpDeclarativeConfigUtil.configureOtlpExporterBuilder(
DATA_TYPE_LOGS,
toExtended(config),
builder::setComponentLoader,
builder::setEndpoint,
builder::addHeader,
builder::setCompression,
builder::setTimeout,
builder::setTrustedCertificates,
builder::setClientTls,
builder::setRetryPolicy,
builder::setMemoryMode,
/* isHttpProtobuf= */ true,
builder::setInternalTelemetryVersion,
() -> builder.setMeterProvider(MeterProvider::noop));

return builder.addHeader(EXTRA_CONTENT_TYPE, STACKTRACES_HEADER_VALUE).build();
}

private static LogRecordExporter buildDeclarativeGrpcExporter(
DeclarativeConfigProperties config) {
OtlpGrpcLogRecordExporterBuilder builder = OtlpGrpcLogRecordExporter.builder();
OtlpDeclarativeConfigUtil.configureOtlpExporterBuilder(
DATA_TYPE_LOGS,
toExtended(config),
builder::setComponentLoader,
builder::setEndpoint,
builder::addHeader,
builder::setCompression,
builder::setTimeout,
builder::setTrustedCertificates,
builder::setClientTls,
builder::setRetryPolicy,
builder::setMemoryMode,
/* isHttpProtobuf= */ false,
builder::setInternalTelemetryVersion,
() -> builder.setMeterProvider(MeterProvider::noop));

return builder.addHeader(EXTRA_CONTENT_TYPE, STACKTRACES_HEADER_VALUE).build();
}

static LogRecordExporter fromEnvironmentConfig() {
ProfilerConfiguration config = ProfilerConfiguration.SUPPLIER.get();
String protocol = config.getOtlpProtocol();
Expand Down
111 changes: 110 additions & 1 deletion profiler/src/test/java/com/splunk/opentelemetry/profiler/LogExporterBuilderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import static com.splunk.opentelemetry.profiler.LogExporterBuilder.STACKTRACES_HEADER_VALUE;
import static com.splunk.opentelemetry.testing.declarativeconfig.DeclarativeConfigTestUtil.getProfilingConfig;
import static io.opentelemetry.api.incubator.config.DeclarativeConfigProperties.empty;
import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.AssertionsForClassTypes.assertThatThrownBy;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.ArgumentMatchers.eq;
Expand All @@ -40,15 +40,22 @@
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.OpenTelemetryConfigurationModel;
import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
import io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException;
import io.opentelemetry.sdk.common.CompletableResultCode;
import io.opentelemetry.sdk.common.export.GrpcSender;
import io.opentelemetry.sdk.common.export.GrpcSenderProvider;
import io.opentelemetry.sdk.common.export.HttpSender;
import io.opentelemetry.sdk.common.export.HttpSenderProvider;
import io.opentelemetry.sdk.logs.export.LogRecordExporter;
import java.net.URI;
import java.time.Duration;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;

class LogExporterBuilderTest {

Expand Down Expand Up @@ -162,6 +169,66 @@ void extraOtlpLogSpecificHeaders() {
@Nested
class DeclarativeConfig {

@ParameterizedTest
@ValueSource(strings = {"otlp_log_http", "otlp_log_grpc", "default"})
void shouldAddProfilingHeaderAutomatically(String exporterType) {
// given
CapturingComponentLoader componentLoader = new CapturingComponentLoader();
Map<String, Object> properties = new HashMap<>();
if (!"default".equals(exporterType)) {
properties.put(exporterType, null);
}
DeclarativeConfigProperties exporterConfig =
YamlDeclarativeConfigProperties.create(properties, componentLoader);

// when
try (LogRecordExporter exporter = LogExporterBuilder.fromDeclarativeConfig(exporterConfig)) {
// then
assertThat(exporter).isNotNull();
assertThat(componentLoader.headers)
.containsEntry(EXTRA_CONTENT_TYPE, List.of(STACKTRACES_HEADER_VALUE));
assertThat(componentLoader.endpoint)
.isEqualTo(
URI.create(
"otlp_log_grpc".equals(exporterType)
? "http://localhost:4317"
: "http://localhost:4318/v1/logs"));
}
}

@ParameterizedTest
@ValueSource(strings = {"otlp_log_http", "otlp_log_grpc"})
void shouldPreserveConfiguredSettingsAndSetProfilingHeader(String exporterType) {
// given
CapturingComponentLoader componentLoader = new CapturingComponentLoader();
Map<String, Object> exporterSettings =
Map.of(
"endpoint", "http://localhost:1234",
"timeout", 1234,
"compression", "gzip",
"headers_list", "X-From-List=one",
"headers",
List.of(
Map.of("name", "X-Custom-Header", "value", "two"),
Map.of("name", EXTRA_CONTENT_TYPE, "value", "custom")));
DeclarativeConfigProperties exporterConfig =
YamlDeclarativeConfigProperties.create(
Map.of(exporterType, exporterSettings), componentLoader);

// when
try (LogRecordExporter exporter = LogExporterBuilder.fromDeclarativeConfig(exporterConfig)) {
// then
assertThat(exporter).isNotNull();
assertThat(componentLoader.headers)
.containsEntry(EXTRA_CONTENT_TYPE, List.of(STACKTRACES_HEADER_VALUE))
.containsEntry("X-From-List", List.of("one"))
.containsEntry("X-Custom-Header", List.of("two"));
assertThat(componentLoader.endpoint).isEqualTo(URI.create("http://localhost:1234"));
assertThat(componentLoader.timeout).isEqualTo(Duration.ofMillis(1234));
assertThat(componentLoader.compression).isEqualTo("gzip");
}
}

@Test
void shouldCreateHttpExporter() {
// given
Expand Down Expand Up @@ -319,6 +386,48 @@ private static DeclarativeConfigProperties exporterConfigWithEmptyNode(
return YamlDeclarativeConfigProperties.create(properties, componentLoader);
}

private static class CapturingComponentLoader implements ComponentLoader {
private final ComponentLoader delegate =
ComponentLoader.forClassLoader(LogExporterBuilderTest.class.getClassLoader());
private Map<String, List<String>> headers;
private URI endpoint;
private Duration timeout;
private String compression;

@Override
public <T> Iterable<T> load(Class<T> spiClass) {
if (spiClass == HttpSenderProvider.class) {
HttpSenderProvider provider =
config -> {
headers = config.getHeadersSupplier().get();
endpoint = config.getEndpoint();
timeout = config.getTimeout();
compression =
config.getCompressor() == null ? null : config.getCompressor().getEncoding();
HttpSender sender = mock(HttpSender.class);
when(sender.shutdown()).thenReturn(CompletableResultCode.ofSuccess());
return sender;
};
return List.of(spiClass.cast(provider));
}
if (spiClass == GrpcSenderProvider.class) {
GrpcSenderProvider provider =
config -> {
headers = config.getHeadersSupplier().get();
endpoint = config.getEndpoint();
timeout = config.getTimeout();
compression =
config.getCompressor() == null ? null : config.getCompressor().getEncoding();
GrpcSender sender = mock(GrpcSender.class);
when(sender.shutdown()).thenReturn(CompletableResultCode.ofSuccess());
return sender;
};
return List.of(spiClass.cast(provider));
}
return delegate.load(spiClass);
}
}

private static class RecordingComponentLoader implements ComponentLoader {
private final ComponentLoader delegate =
ComponentLoader.forClassLoader(LogExporterBuilderTest.class.getClassLoader());
Expand Down
Loading