-
Notifications
You must be signed in to change notification settings - Fork 873
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement UserExcludedClassLoadersConfigurer
Create UserExcludedClassLoadersConfigurer Add documentation for otel.javaagent.exclude-classLoaders property Add UserExcludedClassLoadersConfigurerTest
- Loading branch information
Showing
3 changed files
with
97 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 34 additions & 0 deletions
34
...in/java/io/opentelemetry/javaagent/tooling/ignore/UserExcludedClassLoadersConfigurer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.javaagent.tooling.ignore; | ||
|
||
import static java.util.Collections.emptyList; | ||
|
||
import com.google.auto.service.AutoService; | ||
import io.opentelemetry.javaagent.extension.ignore.IgnoredTypesBuilder; | ||
import io.opentelemetry.javaagent.extension.ignore.IgnoredTypesConfigurer; | ||
import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties; | ||
import java.util.List; | ||
|
||
@AutoService(IgnoredTypesConfigurer.class) | ||
public class UserExcludedClassLoadersConfigurer implements IgnoredTypesConfigurer { | ||
|
||
// visible for tests | ||
static final String EXCLUDED_CLASS_LOADERS_CONFIG = "otel.javaagent.exclude-class-loaders"; | ||
|
||
@Override | ||
public void configure(IgnoredTypesBuilder builder, ConfigProperties config) { | ||
List<String> excludedClassLoaders = config.getList(EXCLUDED_CLASS_LOADERS_CONFIG, emptyList()); | ||
for (String excludedClassLoader : excludedClassLoaders) { | ||
excludedClassLoader = excludedClassLoader.trim(); | ||
// remove the trailing * | ||
if (excludedClassLoader.endsWith("*")) { | ||
excludedClassLoader = excludedClassLoader.substring(0, excludedClassLoader.length() - 1); | ||
} | ||
builder.ignoreClassLoader(excludedClassLoader); | ||
} | ||
} | ||
} |
55 changes: 55 additions & 0 deletions
55
...ava/io/opentelemetry/javaagent/tooling/ignore/UserExcludedClassLoadersConfigurerTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
/* | ||
* Copyright The OpenTelemetry Authors | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
package io.opentelemetry.javaagent.tooling.ignore; | ||
|
||
import static io.opentelemetry.javaagent.tooling.ignore.UserExcludedClassLoadersConfigurer.EXCLUDED_CLASS_LOADERS_CONFIG; | ||
import static java.util.Arrays.asList; | ||
import static java.util.Collections.emptyList; | ||
import static org.mockito.Mockito.verify; | ||
import static org.mockito.Mockito.verifyNoInteractions; | ||
import static org.mockito.Mockito.when; | ||
|
||
import io.opentelemetry.javaagent.extension.ignore.IgnoredTypesBuilder; | ||
import io.opentelemetry.javaagent.extension.ignore.IgnoredTypesConfigurer; | ||
import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties; | ||
import org.junit.jupiter.api.Test; | ||
import org.junit.jupiter.api.extension.ExtendWith; | ||
import org.mockito.Mock; | ||
import org.mockito.junit.jupiter.MockitoExtension; | ||
|
||
@ExtendWith(MockitoExtension.class) | ||
class UserExcludedClassLoadersConfigurerTest { | ||
|
||
@Mock ConfigProperties config; | ||
@Mock IgnoredTypesBuilder builder; | ||
|
||
IgnoredTypesConfigurer underTest = new UserExcludedClassLoadersConfigurer(); | ||
|
||
@Test | ||
void shouldAddNothingToBuilderWhenPropertyIsEmpty() { | ||
// when | ||
underTest.configure(builder, config); | ||
|
||
// then | ||
verifyNoInteractions(builder); | ||
} | ||
|
||
@Test | ||
void shouldIgnoreClassesAndPackages() { | ||
// given | ||
when(config.getList(EXCLUDED_CLASS_LOADERS_CONFIG, emptyList())) | ||
.thenReturn( | ||
asList("com.example.IgnoredClass", "com.example.ignored.*", "com.another_ignore")); | ||
|
||
// when | ||
underTest.configure(builder, config); | ||
|
||
// then | ||
verify(builder).ignoreClassLoader("com.example.IgnoredClass"); | ||
verify(builder).ignoreClassLoader("com.example.ignored."); | ||
verify(builder).ignoreClassLoader("com.another_ignore"); | ||
} | ||
} |