Add package-info.java to all packages and ParamatersAreNonNullByDefault. (#1772)

api/src/main/java/io/opentelemetry/baggage/package-info.java

@@ -17,4 +17,7 @@
  * io.opentelemetry.context.Context}, such as trace ID.
  */
 // TODO: Add code examples.
+@ParametersAreNonnullByDefault
 package io.opentelemetry.baggage;
+
+import javax.annotation.ParametersAreNonnullByDefault;

api/src/main/java/io/opentelemetry/internal/package-info.java

@@ -9,4 +9,7 @@
  * <p>All the content under this package and its subpackages are considered not part of the public
  * API, and should not be used by users of the OpenTelemetry library.
  */
+@ParametersAreNonnullByDefault
 package io.opentelemetry.internal;
+
+import javax.annotation.ParametersAreNonnullByDefault;

api/src/main/java/io/opentelemetry/metrics/package-info.java

@@ -4,4 +4,7 @@
  */
 
 /** This package describes the Metrics API that can be used to record application Metrics. */
+@ParametersAreNonnullByDefault
 package io.opentelemetry.metrics;
+
+import javax.annotation.ParametersAreNonnullByDefault;

api/src/main/java/io/opentelemetry/package-info.java

@@ -0,0 +1,15 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * The OpenTelemetry API.
+ *
+ * <p>Individual features of OpenTelemetry, such as tracing and metrics, can be accessed through
+ * methods on {@link io.opentelemetry.OpenTelemetry}.
+ */
+@ParametersAreNonnullByDefault
+package io.opentelemetry;
+
+import javax.annotation.ParametersAreNonnullByDefault;

api/src/main/java/io/opentelemetry/trace/package-info.java

@@ -19,4 +19,7 @@
  * supported in the {@code opentelemetry.trace.propagation} package.
  */
 // TODO: Add code examples.
+@ParametersAreNonnullByDefault
 package io.opentelemetry.trace;
+
+import javax.annotation.ParametersAreNonnullByDefault;

context/src/main/java/io/opentelemetry/context/package-info.java

@@ -0,0 +1,15 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * A context propagation mechanism which can carry scoped-values across API boundaries and between
+ * threads.
+ *
+ * @see io.opentelemetry.context.Context
+ */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.context;
+
+import javax.annotation.ParametersAreNonnullByDefault;

context_prop/src/main/java/io/opentelemetry/context/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** Utilities for working with context propagation. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.context;
+
+import javax.annotation.ParametersAreNonnullByDefault;

context_prop/src/main/java/io/opentelemetry/context/propagation/package-info.java

@@ -0,0 +1,14 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * Interfaces for defining {@link io.opentelemetry.context.propagation.ContextPropagators} for
+ * allowing context propagation across process boundaries, for example when sending context to a
+ * remote server.
+ */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.context.propagation;
+
+import javax.annotation.ParametersAreNonnullByDefault;

extensions/auto_annotations/src/main/java/io/opentelemetry/extensions/auto/annotations/package-info.java

@@ -13,4 +13,7 @@
  * useless without some kind of annotation processing, such as bytecode manipulation during runtime.
  * You cannot guarantee that users of your library will use that in their production system.
  */
+@ParametersAreNonnullByDefault
 package io.opentelemetry.extensions.auto.annotations;
+
+import javax.annotation.ParametersAreNonnullByDefault;

extensions/runtime_metrics/src/main/java/io/opentelemetry/extensions/metrics/runtime/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** Metric collection for the JVM runtime. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.extensions.metrics.runtime;
+
+import javax.annotation.ParametersAreNonnullByDefault;

extensions/trace_propagators/src/main/java/io/opentelemetry/extensions/trace/propagation/package-info.java

@@ -0,0 +1,13 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * Implementations of {@link io.opentelemetry.context.propagation.TextMapPropagator} for various
+ * formats that are commonly used in distributed tracing.
+ */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.extensions.trace.propagation;
+
+import javax.annotation.ParametersAreNonnullByDefault;

extensions/trace_utils/src/main/java/io/opentelemetry/extensions/trace/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** Experimental utilities for working with tracing APIs. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.extensions.trace;
+
+import javax.annotation.ParametersAreNonnullByDefault;

opentracing_shim/src/main/java/io/opentelemetry/opentracingshim/package-info.java

@@ -0,0 +1,13 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * An OpenTracing implementation that delegates to the OpenTelemetry SDK. Use {@link
+ * io.opentelemetry.opentracingshim.TraceShim} to create tracers using this implementation.
+ */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.opentracingshim;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/all/src/main/java/io/opentelemetry/sdk/package-info.java

@@ -0,0 +1,14 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * The OpenTelemetry SDK.
+ *
+ * @see io.opentelemetry.sdk.OpenTelemetrySdk
+ */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/baggage/src/main/java/io/opentelemetry/sdk/baggage/package-info.java

@@ -0,0 +1,14 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * The SDK implementation of baggage.
+ *
+ * @see io.opentelemetry.sdk.baggage.BaggageManagerSdk
+ */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.baggage;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/baggage/src/main/java/io/opentelemetry/sdk/baggage/spi/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** The SPI implementation which provides the SDK implementation of baggage. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.baggage.spi;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/common/src/main/java/io/opentelemetry/sdk/common/export/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** Common utilities used by SDK exporters. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.common.export;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/common/src/main/java/io/opentelemetry/sdk/common/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** Common utilities used by all SDK components. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.common;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/common/src/main/java/io/opentelemetry/sdk/internal/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** Classes for internal use. Anything in this package can be changed or removed at any time. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.internal;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/common/src/main/java/io/opentelemetry/sdk/resources/package-info.java

@@ -33,4 +33,7 @@
  *       should be disabled.
  * </ul>
  */
+@ParametersAreNonnullByDefault
 package io.opentelemetry.sdk.resources;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/aggregator/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** Metric aggregators. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.metrics.aggregator;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/common/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** Common utilities used by metrics. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.metrics.common;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/data/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** The data format to model metrics for export. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.metrics.data;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/export/package-info.java

@@ -31,4 +31,7 @@
  *   <li>{@code OTEL_IMR_EXPORT_INTERVAL}: sets the export interval between pushes to the exporter.
  * </ul>
  */
+@ParametersAreNonnullByDefault
 package io.opentelemetry.sdk.metrics.export;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/package-info.java

@@ -0,0 +1,14 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * The SDK implementation of metrics.
+ *
+ * @see io.opentelemetry.sdk.metrics.MeterSdkProvider
+ */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.metrics;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/spi/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** The SPI implementation which provides the SDK implementation of metrics. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.metrics.spi;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/view/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** Metric views. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.metrics.view;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/tracing/src/main/java/io/opentelemetry/sdk/trace/config/package-info.java

@@ -62,4 +62,7 @@
  *       link.
  * </ul>
  */
+@ParametersAreNonnullByDefault
 package io.opentelemetry.sdk.trace.config;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/tracing/src/main/java/io/opentelemetry/sdk/trace/data/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** The data format to model traces for export. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.trace.data;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/tracing/src/main/java/io/opentelemetry/sdk/trace/export/package-info.java

@@ -76,4 +76,7 @@
  *   <li>{@code OTEL_BSP_EXPORT_SAMPLED}: sets whether only sampled spans should be exported.
  * </ul>
  */
+@ParametersAreNonnullByDefault
 package io.opentelemetry.sdk.trace.export;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk/tracing/src/main/java/io/opentelemetry/sdk/trace/package-info.java

@@ -0,0 +1,11 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * The OpenTelemetry SDK implementation of tracing.
+ *
+ * @see io.opentelemetry.sdk.trace.TracerSdkProvider
+ */
+package io.opentelemetry.sdk.trace;

sdk/tracing/src/main/java/io/opentelemetry/sdk/trace/spi/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** The SPI implementation which provides the SDK implementation of tracing. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.trace.spi;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk_extensions/async_processor/src/main/java/io/opentelemetry/sdk/extensions/trace/export/package-info.java

@@ -0,0 +1,13 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * An exporter that uses the <a href="https://lmax-exchange.github.io/disruptor/">LMAX Disruptor</a>
+ * for processing exported spans.
+ */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.extensions.trace.export;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk_extensions/aws_v1_support/src/main/java/io/opentelemetry/sdk/extensions/trace/aws/package-info.java

@@ -4,4 +4,7 @@
  */
 
 /** Provides implementations of SDK interfaces which integrate natively with AWS infrastructure. */
+@ParametersAreNonnullByDefault
 package io.opentelemetry.sdk.extensions.trace.aws;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk_extensions/aws_v1_support/src/main/java/io/opentelemetry/sdk/extensions/trace/aws/resource/package-info.java

@@ -0,0 +1,13 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * {@link io.opentelemetry.sdk.resources.ResourceProvider} implementations for inferring resource
+ * information for AWS services.
+ */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.extensions.trace.aws.resource;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk_extensions/jaeger_remote_sampler/src/main/java/io/opentelemetry/sdk/extensions/trace/jaeger/sampler/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** Support for the Jaeger remote sampler. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.extensions.trace.jaeger.sampler;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk_extensions/logging/src/main/java/io/opentelemetry/sdk/logging/data/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** The data format to model logs for export. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.logging.data;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk_extensions/logging/src/main/java/io/opentelemetry/sdk/logging/export/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** Log exporters. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.logging.export;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk_extensions/logging/src/main/java/io/opentelemetry/sdk/logging/package-info.java

@@ -0,0 +1,14 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * The OpenTelemetry SDK implementation of logging.
+ *
+ * @see io.opentelemetry.sdk.logging.LogSinkSdkProvider
+ */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.logging;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk_extensions/otproto/src/main/java/io/opentelemetry/sdk/extensions/otproto/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** Utilities for working with the OTLP format for traces. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.extensions.otproto;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk_extensions/resources/src/main/java/io/opentelemetry/sdk/extensions/resources/package-info.java

@@ -0,0 +1,13 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * {@link io.opentelemetry.sdk.resources.ResourceProvider} implementations for common resource
+ * information.
+ */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.extensions.resources;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk_extensions/tracing_incubator/src/main/java/io/opentelemetry/sdk/extensions/incubator/trace/data/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** Experimental utilities for working with exported trace data. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.extensions.incubator.trace.data;
+
+import javax.annotation.ParametersAreNonnullByDefault;

sdk_extensions/zpages/src/main/java/io/opentelemetry/sdk/extensions/zpages/package-info.java

@@ -0,0 +1,12 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * The ZPages endpoint for providing debug information about an app instrumented with OpenTelemetry.
+ */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.extensions.zpages;
+
+import javax.annotation.ParametersAreNonnullByDefault;

testing_internal/src/main/java/io/opentelemetry/sdk/trace/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/** Testing utilities for OpenTelemetry for internal use. */
+@ParametersAreNonnullByDefault
+package io.opentelemetry.sdk.trace;
+
+import javax.annotation.ParametersAreNonnullByDefault;