Add missing thread safety & immutable annotations in the API. (open-telemetry#972)

jkwatson · web-flow · commit 6ca3d1deaf96 · 2020-03-06T20:02:09.000+01:00
diff --git a/api/src/main/java/io/opentelemetry/correlationcontext/DefaultCorrelationContextManagerProvider.java b/api/src/main/java/io/opentelemetry/correlationcontext/DefaultCorrelationContextManagerProvider.java
@@ -17,7 +17,9 @@
 package io.opentelemetry.correlationcontext;
 
 import io.opentelemetry.correlationcontext.spi.CorrelationContextManagerProvider;
+import javax.annotation.concurrent.ThreadSafe;
 
+@ThreadSafe
 public final class DefaultCorrelationContextManagerProvider
     implements CorrelationContextManagerProvider {
   private static final CorrelationContextManagerProvider instance =
diff --git a/api/src/main/java/io/opentelemetry/correlationcontext/unsafe/CorrelationContextInScope.java b/api/src/main/java/io/opentelemetry/correlationcontext/unsafe/CorrelationContextInScope.java
@@ -19,12 +19,14 @@
 import io.grpc.Context;
 import io.opentelemetry.context.Scope;
 import io.opentelemetry.correlationcontext.CorrelationContext;
+import javax.annotation.concurrent.NotThreadSafe;
 
 /**
  * A scope that manages the {@link Context} for a {@link CorrelationContext}.
  *
  * @since 0.1.0
  */
+@NotThreadSafe
 final class CorrelationContextInScope implements Scope {
   private final Context orig;
 
diff --git a/api/src/main/java/io/opentelemetry/metrics/Counter.java b/api/src/main/java/io/opentelemetry/metrics/Counter.java
@@ -17,13 +17,15 @@
 package io.opentelemetry.metrics;
 
 import io.opentelemetry.metrics.InstrumentWithBinding.BoundInstrument;
+import javax.annotation.concurrent.ThreadSafe;
 
 /**
  * Base interface for all the Counter metrics.
  *
  * @param <H> the Bound Counter type.
  * @since 0.1.0
  */
+@ThreadSafe
 public interface Counter<H extends BoundInstrument> extends InstrumentWithBinding<H> {
 
   /** Builder class for {@link Counter}. */
diff --git a/api/src/main/java/io/opentelemetry/metrics/DefaultMeter.java b/api/src/main/java/io/opentelemetry/metrics/DefaultMeter.java
@@ -21,12 +21,14 @@
 import java.util.List;
 import java.util.Map;
 import javax.annotation.concurrent.Immutable;
+import javax.annotation.concurrent.ThreadSafe;
 
 /**
  * No-op implementations of {@link Meter}.
  *
  * @since 0.1.0
  */
+@ThreadSafe
 public final class DefaultMeter implements Meter {
 
   private static final DefaultMeter INSTANCE = new DefaultMeter();
diff --git a/api/src/main/java/io/opentelemetry/metrics/DefaultMeterProvider.java b/api/src/main/java/io/opentelemetry/metrics/DefaultMeterProvider.java
@@ -16,6 +16,9 @@
 
 package io.opentelemetry.metrics;
 
+import javax.annotation.concurrent.ThreadSafe;
+
+@ThreadSafe
 public class DefaultMeterProvider implements MeterProvider {
 
   private static final MeterProvider instance = new DefaultMeterProvider();
diff --git a/api/src/main/java/io/opentelemetry/metrics/DefaultMetricsProvider.java b/api/src/main/java/io/opentelemetry/metrics/DefaultMetricsProvider.java
@@ -17,7 +17,9 @@
 package io.opentelemetry.metrics;
 
 import io.opentelemetry.metrics.spi.MetricsProvider;
+import javax.annotation.concurrent.ThreadSafe;
 
+@ThreadSafe
 public final class DefaultMetricsProvider implements MetricsProvider {
   private static final MetricsProvider instance = new DefaultMetricsProvider();
 
diff --git a/api/src/main/java/io/opentelemetry/metrics/InstrumentWithBinding.java b/api/src/main/java/io/opentelemetry/metrics/InstrumentWithBinding.java
@@ -17,13 +17,15 @@
 package io.opentelemetry.metrics;
 
 import io.opentelemetry.metrics.InstrumentWithBinding.BoundInstrument;
+import javax.annotation.concurrent.ThreadSafe;
 
 /**
  * Base interface for all metrics with bounds defined in this package.
  *
  * @param <B> the specific type of Bound Instrument this instrument can provide.
  * @since 0.3.0
  */
+@ThreadSafe
 public interface InstrumentWithBinding<B extends BoundInstrument> extends Instrument {
   /**
    * Returns a {@code Bound Instrument} associated with the specified {@code labelSet}. Multiples
diff --git a/api/src/main/java/io/opentelemetry/metrics/LabelSet.java b/api/src/main/java/io/opentelemetry/metrics/LabelSet.java
@@ -16,10 +16,13 @@
 
 package io.opentelemetry.metrics;
 
+import javax.annotation.concurrent.ThreadSafe;
+
 /**
  * LabelSet is an implementation-level interface that represents a set of Labels for use as
  * pre-defined labels in the metrics API.
  *
  * <p>LabelSets that have the same key/value pairs should have the same equals/hashcode.
  */
+@ThreadSafe
 public interface LabelSet {}
diff --git a/api/src/main/java/io/opentelemetry/metrics/Measure.java b/api/src/main/java/io/opentelemetry/metrics/Measure.java
@@ -17,13 +17,15 @@
 package io.opentelemetry.metrics;
 
 import io.opentelemetry.metrics.InstrumentWithBinding.BoundInstrument;
+import javax.annotation.concurrent.ThreadSafe;
 
 /**
  * Base interface for all the Measure instruments.
  *
  * @param <H> the Bound Instrument type.
  * @since 0.1.0
  */
+@ThreadSafe
 public interface Measure<H extends BoundInstrument> extends InstrumentWithBinding<H> {
 
   /** Builder class for {@link Measure}. */
diff --git a/api/src/main/java/io/opentelemetry/metrics/Observer.java b/api/src/main/java/io/opentelemetry/metrics/Observer.java
@@ -16,12 +16,15 @@
 
 package io.opentelemetry.metrics;
 
+import javax.annotation.concurrent.ThreadSafe;
+
 /**
  * Base interface for all the Observer metrics.
  *
  * @param <R> the callback Result type.
  * @since 0.1.0
  */
+@ThreadSafe
 public interface Observer<R> extends Instrument {
   /**
    * A {@code Callback} for a {@code Observer}.
diff --git a/api/src/main/java/io/opentelemetry/trace/BigendianEncoding.java b/api/src/main/java/io/opentelemetry/trace/BigendianEncoding.java
@@ -18,7 +18,9 @@
 
 import io.opentelemetry.internal.Utils;
 import java.util.Arrays;
+import javax.annotation.concurrent.Immutable;
 
+@Immutable
 final class BigendianEncoding {
   static final int LONG_BYTES = Long.SIZE / Byte.SIZE;
   static final int BYTE_BASE16 = 2;
diff --git a/api/src/main/java/io/opentelemetry/trace/DefaultTraceProvider.java b/api/src/main/java/io/opentelemetry/trace/DefaultTraceProvider.java
@@ -17,7 +17,9 @@
 package io.opentelemetry.trace;
 
 import io.opentelemetry.trace.spi.TraceProvider;
+import javax.annotation.concurrent.ThreadSafe;
 
+@ThreadSafe
 public final class DefaultTraceProvider implements TraceProvider {
   private static final TraceProvider instance = new DefaultTraceProvider();
 
diff --git a/api/src/main/java/io/opentelemetry/trace/DefaultTracerProvider.java b/api/src/main/java/io/opentelemetry/trace/DefaultTracerProvider.java
@@ -16,6 +16,9 @@
 
 package io.opentelemetry.trace;
 
+import javax.annotation.concurrent.ThreadSafe;
+
+@ThreadSafe
 public class DefaultTracerProvider implements TracerProvider {
 
   private static final TracerProvider instance = new DefaultTracerProvider();
diff --git a/api/src/main/java/io/opentelemetry/trace/unsafe/SpanInScope.java b/api/src/main/java/io/opentelemetry/trace/unsafe/SpanInScope.java
@@ -19,12 +19,14 @@
 import io.grpc.Context;
 import io.opentelemetry.context.Scope;
 import io.opentelemetry.trace.Span;
+import javax.annotation.concurrent.NotThreadSafe;
 
 /**
  * A scope that manages the {@link Context} for a {@link Span}.
  *
  * @since 0.1.0
  */
+@NotThreadSafe
 final class SpanInScope implements Scope {
   private final Context previous;
   private final Context current;
diff --git a/sdk/src/main/java/io/opentelemetry/sdk/metrics/LabelSetSdk.java b/sdk/src/main/java/io/opentelemetry/sdk/metrics/LabelSetSdk.java
@@ -24,8 +24,10 @@
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
+import javax.annotation.concurrent.Immutable;
 
 @AutoValue
+@Immutable
 abstract class LabelSetSdk implements LabelSet {
   private static final LabelSetSdk EMPTY =
       new AutoValue_LabelSetSdk(Collections.<String, String>emptyMap());
