Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 1 addition & 2 deletions docs/contributing/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,7 @@ methods.
### `final` keyword usage

Public non-internal non-test classes should be declared `final` where possible.
"Internal" here includes `.internal` packages **and** `javaagent/src/main/` classes — javaagent
instrumentation code is not public API.
"Internal" here means classes nested anywhere under a `.internal` package.
"Test" here includes `src/test/` directories and any module whose directory name starts or ends
with `testing` or `tests` (e.g., `testing/`, `testing-common/`, `testing-apps/`,
`quarkus-2.0-testing/`, `smoke-tests/`).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import net.bytebuddy.matcher.ElementMatcher;

@AutoService(InstrumentationModule.class)
public class ActivejHttpServerInstrumentationModule extends InstrumentationModule
public final class ActivejHttpServerInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {

public ActivejHttpServerInstrumentationModule() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import java.util.List;

@AutoService(InstrumentationModule.class)
public class AkkaActorInstrumentationModule extends InstrumentationModule
public final class AkkaActorInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {
public AkkaActorInstrumentationModule() {
super("akka-actor", "akka-actor-2.3");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import io.opentelemetry.javaagent.extension.ignore.IgnoredTypesConfigurer;

@AutoService(IgnoredTypesConfigurer.class)
public class AkkaIgnoredTypesConfigurer implements IgnoredTypesConfigurer {
public final class AkkaIgnoredTypesConfigurer implements IgnoredTypesConfigurer {

@Override
public void configure(IgnoredTypesBuilder builder) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import io.opentelemetry.instrumentation.api.util.VirtualField;
import io.opentelemetry.javaagent.bootstrap.executors.PropagatedContext;

public class VirtualFields {
public final class VirtualFields {

public static final VirtualField<Envelope, PropagatedContext> ENVELOPE_PROPAGATED_CONTEXT =
VirtualField.find(Envelope.class, PropagatedContext.class);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import java.util.List;

@AutoService(InstrumentationModule.class)
public class AkkaActorForkJoinInstrumentationModule extends InstrumentationModule
public final class AkkaActorForkJoinInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {
public AkkaActorForkJoinInstrumentationModule() {
super("akka-actor-fork-join", "akka-actor-fork-join-2.5", "akka-actor");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import io.opentelemetry.javaagent.bootstrap.executors.PropagatedContext;
import java.util.concurrent.Callable;

public class VirtualFields {
public final class VirtualFields {

public static final VirtualField<ForkJoinTask<?>, PropagatedContext>
FORK_JOIN_TASK_PROPAGATED_CONTEXT =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import java.util.List;
import javax.annotation.Nullable;

public class AkkaHttpUtil {
public final class AkkaHttpUtil {

private static final String INSTRUMENTATION_NAME = "io.opentelemetry.akka-http-10.0";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import java.util.List;

@AutoService(InstrumentationModule.class)
public class AkkaHttpClientInstrumentationModule extends InstrumentationModule
public final class AkkaHttpClientInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {
public AkkaHttpClientInstrumentationModule() {
super("akka-http", "akka-http-10.0", "akka-http-client");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
import io.opentelemetry.javaagent.bootstrap.internal.JavaagentHttpClientInstrumenters;
import io.opentelemetry.javaagent.instrumentation.akkahttp.AkkaHttpUtil;

public class AkkaHttpClientSingletons {
public final class AkkaHttpClientSingletons {

private static final HttpHeaderSetter SETTER;
private static final Instrumenter<HttpRequest, HttpResponse> INSTRUMENTER;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
import io.opentelemetry.context.propagation.TextMapSetter;
import javax.annotation.Nullable;

public class HttpHeaderSetter implements TextMapSetter<HttpHeaderSetter.AkkaHttpHeaders> {
public final class HttpHeaderSetter implements TextMapSetter<HttpHeaderSetter.AkkaHttpHeaders> {

private final ContextPropagators contextPropagators;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import scala.runtime.AbstractFunction1;
import scala.util.Try;

public class OnCompleteHandler extends AbstractFunction1<Try<HttpResponse>, Void> {
public final class OnCompleteHandler extends AbstractFunction1<Try<HttpResponse>, Void> {
private final Context context;
private final HttpRequest request;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
import java.util.List;
import javax.annotation.Nullable;

public class AkkaFlowWrapper
public final class AkkaFlowWrapper
extends GraphStage<BidiShape<HttpResponse, HttpResponse, HttpRequest, HttpRequest>> {
private final Inlet<HttpRequest> requestIn = Inlet.create("otel.requestIn");
private final Outlet<HttpRequest> requestOut = Outlet.create("otel.requestOut");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import net.bytebuddy.matcher.ElementMatcher;

@AutoService(InstrumentationModule.class)
public class AkkaHttpServerInstrumentationModule extends InstrumentationModule
public final class AkkaHttpServerInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {
public AkkaHttpServerInstrumentationModule() {
super("akka-http", "akka-http-10.0", "akka-http-server");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import io.opentelemetry.javaagent.extension.ignore.IgnoredTypesConfigurer;

@AutoService(IgnoredTypesConfigurer.class)
public class AkkaServerIgnoredTypesConfigurer implements IgnoredTypesConfigurer {
public final class AkkaServerIgnoredTypesConfigurer implements IgnoredTypesConfigurer {

@Override
public void configure(IgnoredTypesBuilder builder) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* AkkaHttpServerInstrumentationModule applies to classes in akka-http-core.jar
*/
@AutoService(InstrumentationModule.class)
public class AkkaHttpServerRouteInstrumentationModule extends InstrumentationModule
public final class AkkaHttpServerRouteInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {
public AkkaHttpServerRouteInstrumentationModule() {
super("akka-http", "akka-http-10.0", "akka-http-server", "akka-http-server-route");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import java.util.Deque;
import javax.annotation.Nullable;

public class AkkaRouteHolder implements ImplicitContextKeyed {
public final class AkkaRouteHolder implements ImplicitContextKeyed {
private static final ContextKey<AkkaRouteHolder> KEY = named("opentelemetry-akka-route");

private StringBuilder route = new StringBuilder();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
import scala.concurrent.Future;
import scala.runtime.AbstractFunction1;

public class AkkaRouteWrapper extends AbstractFunction1<RequestContext, Future<RouteResult>> {
public final class AkkaRouteWrapper extends AbstractFunction1<RequestContext, Future<RouteResult>> {
private final Function1<RequestContext, Future<RouteResult>> route;

public AkkaRouteWrapper(Function1<RequestContext, Future<RouteResult>> route) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import java.util.List;

@AutoService(InstrumentationModule.class)
public class DruidInstrumentationModule extends InstrumentationModule
public final class DruidInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {

public DruidInstrumentationModule() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import java.util.List;

@AutoService(InstrumentationModule.class)
public class ApacheDbcpInstrumentationModule extends InstrumentationModule {
public final class ApacheDbcpInstrumentationModule extends InstrumentationModule {
public ApacheDbcpInstrumentationModule() {
super("apache-dbcp", "apache-dbcp-2.0");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import net.bytebuddy.matcher.ElementMatcher;

@AutoService(InstrumentationModule.class)
public class DubboInstrumentationModule extends InstrumentationModule
public final class DubboInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {
public DubboInstrumentationModule() {
super("apache-dubbo", "apache-dubbo-2.7");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import java.util.List;

@AutoService(InstrumentationModule.class)
public class ElasticJobInstrumentationModule extends InstrumentationModule
public final class ElasticJobInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {

public ElasticJobInstrumentationModule() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import java.util.List;

@AutoService(InstrumentationModule.class)
public class ApacheHttpAsyncClientInstrumentationModule extends InstrumentationModule
public final class ApacheHttpAsyncClientInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {
public ApacheHttpAsyncClientInstrumentationModule() {
super("apache-httpasyncclient", "apache-httpasyncclient-4.1");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import java.util.List;

@AutoService(InstrumentationModule.class)
public class ApacheHttpClientInstrumentationModule extends InstrumentationModule
public final class ApacheHttpClientInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {

public ApacheHttpClientInstrumentationModule() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import java.util.List;

@AutoService(InstrumentationModule.class)
public class ApacheHttpClientInstrumentationModule extends InstrumentationModule
public final class ApacheHttpClientInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {

public ApacheHttpClientInstrumentationModule() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import java.util.List;

@AutoService(InstrumentationModule.class)
public class ApacheHttpClientInstrumentationModule extends InstrumentationModule
public final class ApacheHttpClientInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {

public ApacheHttpClientInstrumentationModule() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import org.apache.hc.core5.http.message.HttpRequestWrapper;
import org.apache.hc.core5.net.URIAuthority;

public class RequestWithHost extends HttpRequestWrapper implements ClassicHttpRequest {
public final class RequestWithHost extends HttpRequestWrapper implements ClassicHttpRequest {

@Nullable private final String scheme;
@Nullable private final URIAuthority authority;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import org.apache.hc.core5.http.HttpException;
import org.apache.hc.core5.http.io.HttpClientResponseHandler;

public class WrappingStatusSettingResponseHandler<T> implements HttpClientResponseHandler<T> {
public final class WrappingStatusSettingResponseHandler<T> implements HttpClientResponseHandler<T> {
private final Context context;
private final Context parentContext;
private final ClassicHttpRequest request;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import java.util.List;

@AutoService(InstrumentationModule.class)
public class ApacheShenYuInstrumentationModule extends InstrumentationModule {
public final class ApacheShenYuInstrumentationModule extends InstrumentationModule {
public ApacheShenYuInstrumentationModule() {
super("apache-shenyu", "apache-shenyu-2.4");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import net.bytebuddy.matcher.ElementMatcher;

@AutoService(InstrumentationModule.class)
public class ArmeriaInstrumentationModule extends InstrumentationModule
public final class ArmeriaInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {
public ArmeriaInstrumentationModule() {
super("armeria", "armeria-1.3");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import org.reactivestreams.Subscriber;
import org.reactivestreams.Subscription;

public class SubscriberWrapper<T> implements Subscriber<T> {
public final class SubscriberWrapper<T> implements Subscriber<T> {
private static final Class<?> abortingSubscriberClass = getAbortingSubscriberClass();
private static final Class<?> noopSubscriberClass = getNoopSubscriberClass();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import java.util.List;

@AutoService(InstrumentationModule.class)
public class ArmeriaGrpcInstrumentationModule extends InstrumentationModule {
public final class ArmeriaGrpcInstrumentationModule extends InstrumentationModule {
public ArmeriaGrpcInstrumentationModule() {
super("armeria-grpc", "armeria-grpc-1.14", "armeria", "armeria-1.14");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.matcher.ElementMatcher;

public class ResponseInstrumentation implements TypeInstrumentation {
public final class ResponseInstrumentation implements TypeInstrumentation {

@Override
public ElementMatcher<ClassLoader> classLoaderOptimization() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import net.bytebuddy.matcher.ElementMatcher;

@AutoService(InstrumentationModule.class)
public class AsyncHttpClientInstrumentationModule extends InstrumentationModule
public final class AsyncHttpClientInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {
public AsyncHttpClientInstrumentationModule() {
super("async-http-client", "async-http-client-1.8");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import net.bytebuddy.matcher.ElementMatcher;

@AutoService(InstrumentationModule.class)
public class AsyncHttpClientInstrumentationModule extends InstrumentationModule
public final class AsyncHttpClientInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {
public AsyncHttpClientInstrumentationModule() {
super("async-http-client", "async-http-client-1.9");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import java.util.List;

@AutoService(InstrumentationModule.class)
public class AsyncHttpClientInstrumentationModule extends InstrumentationModule
public final class AsyncHttpClientInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {
public AsyncHttpClientInstrumentationModule() {
super("async-http-client", "async-http-client-2.0");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

@SuppressWarnings("unused")
@AutoService(InstrumentationModule.class)
public class JexInstrumentationModule extends InstrumentationModule {
public final class JexInstrumentationModule extends InstrumentationModule {

public JexInstrumentationModule() {
super("avaje-jex", "avaje-jex-3.0");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import net.bytebuddy.matcher.ElementMatcher;

@AutoService(InstrumentationModule.class)
public class AwsLambdaInstrumentationModule extends InstrumentationModule
public final class AwsLambdaInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {

public AwsLambdaInstrumentationModule() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import net.bytebuddy.matcher.ElementMatcher;

@AutoService(InstrumentationModule.class)
public class AwsLambdaInstrumentationModule extends InstrumentationModule
public final class AwsLambdaInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {
public AwsLambdaInstrumentationModule() {
super("aws-lambda-events", "aws-lambda-events-2.2", "aws-lambda");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import java.util.List;

@AutoService(InstrumentationModule.class)
public class AwsSdkInstrumentationModule extends InstrumentationModule
public final class AwsSdkInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {
public AwsSdkInstrumentationModule() {
super("aws-sdk", "aws-sdk-1.11", "aws-sdk-1.11-core");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import net.bytebuddy.asm.Advice;

@AutoService(InstrumentationModule.class)
public class SqsInstrumentationModule extends AbstractAwsSdkInstrumentationModule {
public final class SqsInstrumentationModule extends AbstractAwsSdkInstrumentationModule {

public SqsInstrumentationModule() {
super("aws-sdk-1.11-sqs");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
// NB: If the error-handling workarounds stop working, we should consider introducing the same
// x-amzn-request-id header check in Apache instrumentation for suppressing spans that we have in
// Netty instrumentation.
public class TracingRequestHandler extends RequestHandler2 {
public final class TracingRequestHandler extends RequestHandler2 {

public static final HandlerContextKey<Scope> SCOPE =
new HandlerContextKey<>(Scope.class.getName());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import java.util.List;

@AutoService(InstrumentationModule.class)
public class AwsSdkInstrumentationModule extends AbstractAwsSdkInstrumentationModule {
public final class AwsSdkInstrumentationModule extends AbstractAwsSdkInstrumentationModule {
public AwsSdkInstrumentationModule() {
super("aws-sdk-2.2-core");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import net.bytebuddy.matcher.ElementMatcher;

@AutoService(InstrumentationModule.class)
public class BedrockRuntimeInstrumentationModule extends AbstractAwsSdkInstrumentationModule {
public final class BedrockRuntimeInstrumentationModule extends AbstractAwsSdkInstrumentationModule {

public BedrockRuntimeInstrumentationModule() {
super("aws-sdk-2.2-bedrock-runtime");
Expand Down
Loading
Loading