Rename disabled resources property to be consistent with agent. (#2792)

* Rename disabled resources property to be consistent with agent.

* property > env
This commit is contained in:
Anuraag Agrawal 2021-02-12 13:45:33 +09:00 committed by GitHub
parent 762aca003b
commit bace5dce1f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 73 additions and 4 deletions

View File

@ -3,6 +3,7 @@ plugins {
id("maven-publish")
id("ru.vyarus.animalsniffer")
id("org.unbroken-dome.test-sets")
}
description = "OpenTelemetry SDK Common"
@ -10,6 +11,11 @@ extra["moduleName"] = "io.opentelemetry.sdk.common"
val mrJarVersions = listOf(9)
testSets {
create("testResourceDisabledByProperty")
create("testResourceDisabledByEnv")
}
dependencies {
api(project(":api:all"))
api(project(":semconv"))
@ -19,6 +25,7 @@ dependencies {
testAnnotationProcessor("com.google.auto.value:auto-value")
testImplementation(project(":sdk:testing"))
testImplementation(project(":sdk-extensions:resources"))
testImplementation("com.google.guava:guava-testlib")
}
@ -79,4 +86,15 @@ tasks {
"Multi-Release" to "true"
)
}
}
named<Test>("testResourceDisabledByProperty") {
jvmArgs("-Dotel.java.disabled.resource-providers=io.opentelemetry.sdk.extension.resources.OsResource,io.opentelemetry.sdk.extension.resources.ProcessResource")
// Properties win, this is ignored.
environment("OTEL_JAVA_DISABLED_RESOURCE_PROVIDERS", "io.opentelemetry.sdk.extension.resources.ProcessRuntimeResource")
}
named<Test>("testResourceDisabledByEnv") {
environment("OTEL_JAVA_DISABLED_RESOURCE_PROVIDERS", "io.opentelemetry.sdk.extension.resources.OsResource,io.opentelemetry.sdk.extension.resources.ProcessResource")
}
}

View File

@ -40,7 +40,7 @@ import javax.annotation.concurrent.Immutable;
public abstract class Resource {
private static final String OTEL_JAVA_DISABLED_RESOURCES_PROVIDERS_PROPERTY_KEY =
"otel.java.disabled.resource_providers";
"otel.java.disabled.resource-providers";
private static final String OTEL_JAVA_DISABLED_RESOURCES_PROVIDERS_ENV_KEY =
"OTEL_JAVA_DISABLED_RESOURCE_PROVIDERS";
@ -90,10 +90,10 @@ public abstract class Resource {
private static Resource readResourceFromProviders() {
String disabledResourceProvidersConfig =
System.getenv(OTEL_JAVA_DISABLED_RESOURCES_PROVIDERS_ENV_KEY);
System.getProperty(OTEL_JAVA_DISABLED_RESOURCES_PROVIDERS_PROPERTY_KEY, "");
if (disabledResourceProvidersConfig == null) {
disabledResourceProvidersConfig =
System.getProperty(OTEL_JAVA_DISABLED_RESOURCES_PROVIDERS_PROPERTY_KEY, "");
System.getenv(OTEL_JAVA_DISABLED_RESOURCES_PROVIDERS_ENV_KEY);
}
Set<String> disabledResourceProviders =
Arrays.stream(disabledResourceProvidersConfig.split(","))

View File

@ -8,6 +8,7 @@ package io.opentelemetry.sdk.resources;
import static io.opentelemetry.api.common.AttributeKey.longKey;
import static org.assertj.core.api.Assertions.assertThat;
import io.opentelemetry.semconv.resource.attributes.ResourceAttributes;
import org.junit.jupiter.api.Test;
class ResourceProvidersTest {
@ -19,5 +20,9 @@ class ResourceProvidersTest {
long providerAttribute = resource.getAttributes().get(longKey("providerAttribute"));
assertThat(providerAttribute).isNotNull();
assertThat(providerAttribute).isEqualTo(42);
assertThat(resource.getAttributes().get(ResourceAttributes.OS_TYPE)).isNotNull();
assertThat(resource.getAttributes().get(ResourceAttributes.PROCESS_PID)).isNotNull();
assertThat(resource.getAttributes().get(ResourceAttributes.PROCESS_RUNTIME_NAME)).isNotNull();
}
}

View File

@ -0,0 +1,23 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package io.opentelemetry.sdk.resources;
import static org.assertj.core.api.Assertions.assertThat;
import io.opentelemetry.semconv.resource.attributes.ResourceAttributes;
import org.junit.jupiter.api.Test;
class ResourceDisabledByEnvTest {
@Test
void osAndProcessDisabled() {
Resource resource = Resource.getDefault();
assertThat(resource.getAttributes().get(ResourceAttributes.OS_TYPE)).isNull();
assertThat(resource.getAttributes().get(ResourceAttributes.PROCESS_PID)).isNull();
assertThat(resource.getAttributes().get(ResourceAttributes.PROCESS_RUNTIME_NAME)).isNotNull();
}
}

View File

@ -0,0 +1,23 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package io.opentelemetry.sdk.resources;
import static org.assertj.core.api.Assertions.assertThat;
import io.opentelemetry.semconv.resource.attributes.ResourceAttributes;
import org.junit.jupiter.api.Test;
class ResourceDisabledByPropertyTest {
@Test
void osAndProcessDisabled() {
Resource resource = Resource.getDefault();
assertThat(resource.getAttributes().get(ResourceAttributes.OS_TYPE)).isNull();
assertThat(resource.getAttributes().get(ResourceAttributes.PROCESS_PID)).isNull();
assertThat(resource.getAttributes().get(ResourceAttributes.PROCESS_RUNTIME_NAME)).isNotNull();
}
}