Skip to content

New - Support distribution.solarwinds config node with per-key merging #549

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

Open
cleverchuk wants to merge 7 commits into
base: main
Choose a base branch
from
Open

New - Support distribution.solarwinds config node with per-key merging #549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
41e7794
Fix flaky test
cleverchuk Jul 21, 2026
f3e363f
read distribution node for shared agent configs
cleverchuk Jul 21, 2026
be6d3db
add thread name to apm logs
cleverchuk Jul 22, 2026
4b37040
update sdk-config.yaml
cleverchuk Jul 22, 2026
f2c8b59
also still check instrumentation node
cleverchuk Jul 22, 2026
28c213a
use merging
cleverchuk Jul 22, 2026
fca48d1
add resolver test
cleverchuk Jul 22, 2026
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
79 changes: 44 additions & 35 deletions custom/src/main/java/com/solarwinds/opentelemetry/extensions/config/DeclarativeLoader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,53 +25,62 @@
import com.solarwinds.joboe.logging.LoggerFactory;
import com.solarwinds.opentelemetry.extensions.LoggingConfigProvider;
import com.solarwinds.opentelemetry.extensions.config.parser.yaml.DeclarativeConfigParser;
import io.opentelemetry.api.incubator.ExtendedOpenTelemetry;
import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
import io.opentelemetry.javaagent.tooling.BeforeAgentListener;
import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.DeclarativeConfiguration;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.DeclarativeConfigurationCustomizer;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.DeclarativeConfigurationCustomizerProvider;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.OpenTelemetryConfigurationModel;
import java.util.Objects;

@AutoService(BeforeAgentListener.class)
public class DeclarativeLoader implements BeforeAgentListener {
@AutoService(DeclarativeConfigurationCustomizerProvider.class)
public class DeclarativeLoader implements DeclarativeConfigurationCustomizerProvider {
private static final Logger logger = LoggerFactory.getLogger();

@Override
public void beforeAgent(AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk) {
OpenTelemetrySdk openTelemetrySdk = autoConfiguredOpenTelemetrySdk.getOpenTelemetrySdk();
if (!(openTelemetrySdk instanceof ExtendedOpenTelemetry)) {
// Shouldn't happen in practice, but just in case
logger.warn(
"OpenTelemetrySdk is not an instance of ExtendedOpenTelemetry. Declarative configuration will not be applied.");
return;
}
public void customize(DeclarativeConfigurationCustomizer customizer) {
customizer.addModelCustomizer(
configurationModel -> {
loadConfig(configurationModel);
return configurationModel;
});
}

private void loadConfig(OpenTelemetryConfigurationModel configurationModel) {
DeclarativeConfigProperties configProperties =
DeclarativeConfiguration.toConfigProperties(configurationModel);

ExtendedOpenTelemetry extendedOpenTelemetry = (ExtendedOpenTelemetry) openTelemetrySdk;
// SolarwindsConfigResolver merges the distribution and instrumentation nodes per key
// (distribution takes precedence, instrumentation fills the rest); it returns null when
// neither node carries any properties.
DeclarativeConfigProperties solarwinds =
extendedOpenTelemetry.getInstrumentationConfig("solarwinds");
Objects.requireNonNull(
SolarwindsConfigResolver.resolve(configProperties),
"Solarwinds configuration cannot be null.");

if (solarwinds != null && !solarwinds.getPropertyKeys().isEmpty()) {
try {
ConfigContainer configContainer = new ConfigContainer();
DeclarativeConfigParser declarativeConfigParser =
new DeclarativeConfigParser(configContainer);
ConfigContainer configContainer = new ConfigContainer();
DeclarativeConfigParser declarativeConfigParser = new DeclarativeConfigParser(configContainer);

declarativeConfigParser.parse(solarwinds);
ConfigurationLoader.processConfigs(configContainer);
try {
declarativeConfigParser.parse(solarwinds);
} catch (InvalidConfigException e) {
throw new RuntimeException(e);
}

ConfigContainer agentConfig = configContainer.subset(ConfigGroup.AGENT);
LoggerFactory.init(LoggingConfigProvider.getLoggerConfiguration(agentConfig));
logger.info("Loaded via declarative config");
try {
ConfigurationLoader.processConfigs(configContainer);
ConfigContainer agentConfig = configContainer.subset(ConfigGroup.AGENT);
LoggerFactory.init(LoggingConfigProvider.getLoggerConfiguration(agentConfig));

} catch (InvalidConfigException e) {
throw new RuntimeException(e);
}
logger.info("Loaded via declarative config");
} catch (InvalidConfigException e) {
throw new RuntimeException(e);
}

if (!JavaRuntimeVersionChecker.isJdkVersionSupported()) {
logger.warn(
String.format(
"Profiling is not supported for Java runtime version: %s . The lowest Java version supported for profiling is %s.",
System.getProperty("java.version"), JavaRuntimeVersionChecker.minVersionSupported));
}
if (!JavaRuntimeVersionChecker.isJdkVersionSupported()) {
logger.warn(
String.format(
"Profiling is not supported for Java runtime version: %s . The lowest Java version supported for profiling is %s.",
System.getProperty("java.version"), JavaRuntimeVersionChecker.minVersionSupported));
}
}
}
182 changes: 160 additions & 22 deletions ...m/src/test/java/com/solarwinds/opentelemetry/extensions/config/DeclarativeLoaderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,28 @@

package com.solarwinds.opentelemetry.extensions.config;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.when;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.Mockito.verify;

import com.solarwinds.joboe.config.ConfigManager;
import com.solarwinds.joboe.config.ConfigProperty;
import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.DeclarativeConfiguration;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.DeclarativeConfigurationCustomizer;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.DistributionModel;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.DistributionPropertyModel;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.ExperimentalInstrumentationModel;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.ExperimentalLanguageSpecificInstrumentationModel;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.ExperimentalLanguageSpecificInstrumentationPropertyModel;
import io.opentelemetry.sdk.internal.ExtendedOpenTelemetrySdk;
import io.opentelemetry.sdk.autoconfigure.declarativeconfig.model.OpenTelemetryConfigurationModel;
import java.util.function.Function;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
Expand All @@ -39,33 +47,163 @@ class DeclarativeLoaderTest {

@InjectMocks private DeclarativeLoader tested;

@Mock private AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdkMock;
@Mock private DeclarativeConfigurationCustomizer customizerMock;

@Mock private ExtendedOpenTelemetrySdk extendedOpenTelemetrySdkMock;
@Captor
private ArgumentCaptor<Function<OpenTelemetryConfigurationModel, OpenTelemetryConfigurationModel>>
modelCustomizerCaptor;

private final ExperimentalLanguageSpecificInstrumentationPropertyModel solarwinds =
new ExperimentalLanguageSpecificInstrumentationPropertyModel()
.withAdditionalProperty(
ConfigProperty.AGENT_SERVICE_KEY.getConfigFileKey(), "token:service")
.withAdditionalProperty(
ConfigProperty.AGENT_COLLECTOR.getConfigFileKey(), "apm.collector.com");
@BeforeEach
public void resetConfig() {
ConfigManager.reset();
}

@AfterAll
public static void clearConfig() {
ConfigManager.reset();
}

@Test
public void testBeforeAgent() {
DeclarativeConfigProperties configProperties =
DeclarativeConfiguration.toConfigProperties(solarwinds);
when(autoConfiguredOpenTelemetrySdkMock.getOpenTelemetrySdk())
.thenReturn(extendedOpenTelemetrySdkMock);
when(extendedOpenTelemetrySdkMock.getInstrumentationConfig(eq("solarwinds")))
.thenReturn(configProperties);
tested.beforeAgent(autoConfiguredOpenTelemetrySdkMock);
public void testCustomizeLoadsDistributionConfig() {
OpenTelemetryConfigurationModel model =
new OpenTelemetryConfigurationModel()
.withDistribution(
new DistributionModel()
.withAdditionalProperty(
"solarwinds",
new DistributionPropertyModel()
.withAdditionalProperty(
ConfigProperty.AGENT_SERVICE_KEY.getConfigFileKey(),
"token:service")
.withAdditionalProperty(
ConfigProperty.AGENT_COLLECTOR.getConfigFileKey(),
"apm.collector.com")));

OpenTelemetryConfigurationModel returned = customize(model);

assertNotNull(ConfigManager.getConfig(ConfigProperty.AGENT_COLLECTOR));
assertNotNull(ConfigManager.getConfig(ConfigProperty.AGENT_SERVICE_KEY));
assertEquals(model, returned);
}

@Test
public void testCustomizeLoadsInstrumentationConfig() {
OpenTelemetryConfigurationModel model =
new OpenTelemetryConfigurationModel()
.withInstrumentationDevelopment(
new ExperimentalInstrumentationModel()
.withJava(
new ExperimentalLanguageSpecificInstrumentationModel()
.withAdditionalProperty(
"solarwinds",
new ExperimentalLanguageSpecificInstrumentationPropertyModel()
.withAdditionalProperty(
ConfigProperty.AGENT_SERVICE_KEY.getConfigFileKey(),
"token:service")
.withAdditionalProperty(
ConfigProperty.AGENT_COLLECTOR.getConfigFileKey(),
"apm.collector.com"))));

customize(model);

assertNotNull(ConfigManager.getConfig(ConfigProperty.AGENT_COLLECTOR));
assertNotNull(ConfigManager.getConfig(ConfigProperty.AGENT_SERVICE_KEY));
}

@Test
public void testDistributionTakesPrecedenceWhenBothNodesPresent() {
OpenTelemetryConfigurationModel model =
new OpenTelemetryConfigurationModel()
.withDistribution(distribution("distribution-token:distribution-service"))
.withInstrumentationDevelopment(instrumentation("instrumentation-token:inst-service"));

customize(model);

assertEquals(
"distribution-token:distribution-service",
ConfigManager.getConfig(ConfigProperty.AGENT_SERVICE_KEY));
}

@Test
public void testCustomizeWithEmptyModelThrows() {
OpenTelemetryConfigurationModel model = new OpenTelemetryConfigurationModel();

assertThrows(NullPointerException.class, () -> customize(model));
assertNull(ConfigManager.getConfig(ConfigProperty.AGENT_SERVICE_KEY));
}

@Test
public void testCustomizeSkipsEmptySolarwindsNode() {
OpenTelemetryConfigurationModel model =
new OpenTelemetryConfigurationModel()
.withDistribution(
new DistributionModel()
.withAdditionalProperty("solarwinds", new DistributionPropertyModel()))
.withInstrumentationDevelopment(instrumentation("token:service"));

customize(model);

assertEquals("token:service", ConfigManager.getConfig(ConfigProperty.AGENT_SERVICE_KEY));
}

@Test
public void testCustomizeThrowsOnUnknownKey() {
OpenTelemetryConfigurationModel model =
new OpenTelemetryConfigurationModel()
.withDistribution(
new DistributionModel()
.withAdditionalProperty(
"solarwinds",
new DistributionPropertyModel()
.withAdditionalProperty("not_a_real_config_key", "value")));

assertThrows(RuntimeException.class, () -> customize(model));
}

@Test
public void testCustomizeThrowsWhenServiceKeyMissing() {
OpenTelemetryConfigurationModel model =
new OpenTelemetryConfigurationModel()
.withDistribution(
new DistributionModel()
.withAdditionalProperty(
"solarwinds",
new DistributionPropertyModel()
.withAdditionalProperty(
ConfigProperty.AGENT_COLLECTOR.getConfigFileKey(),
"apm.collector.com")));

assertThrows(RuntimeException.class, () -> customize(model));
}

private static DistributionModel distribution(String serviceKey) {
return new DistributionModel()
.withAdditionalProperty(
"solarwinds",
new DistributionPropertyModel()
.withAdditionalProperty(
ConfigProperty.AGENT_SERVICE_KEY.getConfigFileKey(), serviceKey)
.withAdditionalProperty(
ConfigProperty.AGENT_COLLECTOR.getConfigFileKey(), "apm.collector.com"));
}

private static ExperimentalInstrumentationModel instrumentation(String serviceKey) {
return new ExperimentalInstrumentationModel()
.withJava(
new ExperimentalLanguageSpecificInstrumentationModel()
.withAdditionalProperty(
"solarwinds",
new ExperimentalLanguageSpecificInstrumentationPropertyModel()
.withAdditionalProperty(
ConfigProperty.AGENT_SERVICE_KEY.getConfigFileKey(), serviceKey)
.withAdditionalProperty(
ConfigProperty.AGENT_COLLECTOR.getConfigFileKey(),
"apm.collector.com")));
}

private OpenTelemetryConfigurationModel customize(OpenTelemetryConfigurationModel model) {
tested.customize(customizerMock);
verify(customizerMock).addModelCustomizer(modelCustomizerCaptor.capture());
return modelCustomizerCaptor.getValue().apply(model);
}
}
Loading
Loading