diff --git a/api/all/src/main/java/io/opentelemetry/api/common/AttributesBuilder.java b/api/all/src/main/java/io/opentelemetry/api/common/AttributesBuilder.java index 4738841a400..05a76675693 100644 --- a/api/all/src/main/java/io/opentelemetry/api/common/AttributesBuilder.java +++ b/api/all/src/main/java/io/opentelemetry/api/common/AttributesBuilder.java @@ -44,7 +44,7 @@ public interface AttributesBuilder { *

Simple attributes ({@link AttributeType#STRING}, {@link AttributeType#LONG}, {@link * AttributeType#DOUBLE}, {@link AttributeType#BOOLEAN}, {@link AttributeType#STRING_ARRAY}, * {@link AttributeType#LONG_ARRAY}, {@link AttributeType#DOUBLE_ARRAY}, {@link - * AttributeType#BOOLEAN_ARRAY}) SHOULD be used whenever possible. Instrumentations SHOULD assume + * AttributeType#BOOLEAN_ARRAY}) should be used whenever possible. Instrumentations should assume * that backends do not index individual properties of complex attributes, that querying or * aggregating on such properties is inefficient and complicated, and that reporting complex * attributes carries higher performance overhead. diff --git a/api/incubator/src/main/java/io/opentelemetry/api/incubator/common/ExtendedAttributeKey.java b/api/incubator/src/main/java/io/opentelemetry/api/incubator/common/ExtendedAttributeKey.java index 89a90efe8c6..5dadaf1ff39 100644 --- a/api/incubator/src/main/java/io/opentelemetry/api/incubator/common/ExtendedAttributeKey.java +++ b/api/incubator/src/main/java/io/opentelemetry/api/incubator/common/ExtendedAttributeKey.java @@ -114,8 +114,8 @@ static ExtendedAttributeKey extendedAttributesKey(String key *

Simple attributes ({@link ExtendedAttributeType#STRING}, {@link ExtendedAttributeType#LONG}, * {@link ExtendedAttributeType#DOUBLE}, {@link ExtendedAttributeType#BOOLEAN}, {@link * ExtendedAttributeType#STRING_ARRAY}, {@link ExtendedAttributeType#LONG_ARRAY}, {@link - * ExtendedAttributeType#DOUBLE_ARRAY}, {@link ExtendedAttributeType#BOOLEAN_ARRAY}) SHOULD be - * used whenever possible. Instrumentations SHOULD assume that backends do not index individual + * ExtendedAttributeType#DOUBLE_ARRAY}, {@link ExtendedAttributeType#BOOLEAN_ARRAY}) should be + * used whenever possible. Instrumentations should assume that backends do not index individual * properties of complex attributes, that querying or aggregating on such properties is * inefficient and complicated, and that reporting complex attributes carries higher performance * overhead. diff --git a/api/incubator/src/main/java/io/opentelemetry/api/incubator/common/ExtendedAttributesBuilder.java b/api/incubator/src/main/java/io/opentelemetry/api/incubator/common/ExtendedAttributesBuilder.java index a8f7fdf72a4..69c5dc3d38f 100644 --- a/api/incubator/src/main/java/io/opentelemetry/api/incubator/common/ExtendedAttributesBuilder.java +++ b/api/incubator/src/main/java/io/opentelemetry/api/incubator/common/ExtendedAttributesBuilder.java @@ -38,8 +38,8 @@ default ExtendedAttributesBuilder put(AttributeKey key, T value) { *

Simple attributes ({@link ExtendedAttributeType#STRING}, {@link ExtendedAttributeType#LONG}, * {@link ExtendedAttributeType#DOUBLE}, {@link ExtendedAttributeType#BOOLEAN}, {@link * ExtendedAttributeType#STRING_ARRAY}, {@link ExtendedAttributeType#LONG_ARRAY}, {@link - * ExtendedAttributeType#DOUBLE_ARRAY}, {@link ExtendedAttributeType#BOOLEAN_ARRAY}) SHOULD be - * used whenever possible. Instrumentations SHOULD assume that backends do not index individual + * ExtendedAttributeType#DOUBLE_ARRAY}, {@link ExtendedAttributeType#BOOLEAN_ARRAY}) should be + * used whenever possible. Instrumentations should assume that backends do not index individual * properties of complex attributes, that querying or aggregating on such properties is * inefficient and complicated, and that reporting complex attributes carries higher performance * overhead. diff --git a/context/src/main/java/io/opentelemetry/context/Context.java b/context/src/main/java/io/opentelemetry/context/Context.java index 4dc7fd6e60a..cfa4fa98950 100644 --- a/context/src/main/java/io/opentelemetry/context/Context.java +++ b/context/src/main/java/io/opentelemetry/context/Context.java @@ -212,7 +212,7 @@ default Context with(ImplicitContextKeyed value) { * Scope#close()} automatically. * *

The default implementation of this method will store the {@link Context} in a {@link - * ThreadLocal}. Kotlin coroutine users SHOULD NOT use this method as the {@link ThreadLocal} will + * ThreadLocal}. Kotlin coroutine users should not use this method as the {@link ThreadLocal} will * not be properly synced across coroutine suspension and resumption. Instead, use {@code * withContext(context.asContextElement())} provided by the {@code opentelemetry-extension-kotlin} * library. diff --git a/context/src/main/java/io/opentelemetry/context/ImplicitContextKeyed.java b/context/src/main/java/io/opentelemetry/context/ImplicitContextKeyed.java index 48eccfd77b1..327f90c8d11 100644 --- a/context/src/main/java/io/opentelemetry/context/ImplicitContextKeyed.java +++ b/context/src/main/java/io/opentelemetry/context/ImplicitContextKeyed.java @@ -23,7 +23,7 @@ public interface ImplicitContextKeyed { *

This method is equivalent to {@code Context.current().with(value).makeCurrent()}. * *

The default implementation of this method will store the {@link ImplicitContextKeyed} in a - * {@link ThreadLocal}. Kotlin coroutine users SHOULD NOT use this method as the {@link + * {@link ThreadLocal}. Kotlin coroutine users should not use this method as the {@link * ThreadLocal} will not be properly synced across coroutine suspension and resumption. Instead, * use {@code withContext(value.asContextElement())} provided by the {@code * opentelemetry-extension-kotlin} library. diff --git a/sdk/common/src/main/java/io/opentelemetry/sdk/resources/package-info.java b/sdk/common/src/main/java/io/opentelemetry/sdk/resources/package-info.java index f905c4c3f6f..07808bdbe8e 100644 --- a/sdk/common/src/main/java/io/opentelemetry/sdk/resources/package-info.java +++ b/sdk/common/src/main/java/io/opentelemetry/sdk/resources/package-info.java @@ -13,7 +13,7 @@ * *

Attribute keys, and attribute values MUST contain only printable ASCII (codes between 32 and * 126, inclusive) and less than 256 characters. Type and attribute keys MUST have a length greater - * than zero. They SHOULD start with a domain name and separate hierarchies with / characters, e.g. + * than zero. They should start with a domain name and separate hierarchies with / characters, e.g. * k8s.io/namespace/name. */ @ParametersAreNonnullByDefault diff --git a/sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/export/MetricProducer.java b/sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/export/MetricProducer.java index 723eb7e1e92..c636a187c64 100644 --- a/sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/export/MetricProducer.java +++ b/sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/export/MetricProducer.java @@ -19,7 +19,7 @@ *

Alternative {@link MetricProducer} implementations can be used to bridge aggregated metrics * from other frameworks, and are registered with {@link * SdkMeterProviderBuilder#registerMetricProducer(MetricProducer)}. NOTE: When possible, metrics - * from other frameworks SHOULD be bridged using the metric API, normally with asynchronous + * from other frameworks should be bridged using the metric API, normally with asynchronous * instruments which observe the aggregated state of the other framework. However, {@link * MetricProducer} exists to accommodate scenarios where the metric API is insufficient. It should * be used with caution as it requires the bridge to take a dependency on {@code diff --git a/sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/internal/view/FilteredAttributes.java b/sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/internal/view/FilteredAttributes.java index d71616c20e8..a06ca741fba 100644 --- a/sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/internal/view/FilteredAttributes.java +++ b/sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/internal/view/FilteredAttributes.java @@ -47,7 +47,7 @@ private FilteredAttributes(Object[] sourceData, int hashcode, int size) { /** * Create a {@link FilteredAttributes} instance. * - * @param source the source attributes, which SHOULD be based on the standard {@link + * @param source the source attributes, which should be based on the standard {@link * ImmutableKeyValuePairs}. If not, the source will first be converted to the standard * implementation. * @param includedKeys the set of attribute keys to include in the output. diff --git a/sdk/profiles/src/main/java/io/opentelemetry/sdk/profiles/data/ProfileData.java b/sdk/profiles/src/main/java/io/opentelemetry/sdk/profiles/data/ProfileData.java index 892893b4ea5..9e30af7f4e0 100644 --- a/sdk/profiles/src/main/java/io/opentelemetry/sdk/profiles/data/ProfileData.java +++ b/sdk/profiles/src/main/java/io/opentelemetry/sdk/profiles/data/ProfileData.java @@ -121,7 +121,7 @@ default byte[] getProfileIdBytes() { /** * Returns the original payload, in a profiler-native format e.g. JFR. Optional. Default behavior * should be to not include the original payload. If the original payload is in pprof format, it - * SHOULD not be included in this field. + * should not be included in this field. */ ByteBuffer getOriginalPayload();