cleanup and rename locals to scope

Author: SylvainJuge

instrumentation/google-http-client-1.19/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/googlehttpclient/GoogleHttpRequestInstrumentation.java

@@ -50,28 +50,28 @@ public void transform(TypeTransformer transformer) {
         this.getClass().getName() + "$ExecuteAsyncAdvice");
   }
 
-  public static class AdviceLocals {
+  public static class AdviceScope {
 
     private static final VirtualField<HttpRequest, Context> virtualField =
         VirtualField.find(HttpRequest.class, Context.class);
     private final Context context;
     private final Scope scope;
 
-    public AdviceLocals(Context context, Scope scope) {
+    public AdviceScope(Context context, Scope scope) {
       this.context = context;
       this.scope = scope;
     }
 
     @Nullable
-    public static AdviceLocals start(HttpRequest request) {
+    public static AdviceScope start(HttpRequest request) {
 
       Context parentContext = currentContext();
       if (!instrumenter().shouldStart(parentContext, request)) {
         return null;
       }
 
       Context context = instrumenter().start(parentContext, request);
-      return new AdviceLocals(context, context.makeCurrent());
+      return new AdviceScope(context, context.makeCurrent());
     }
 
     public void end(HttpRequest request, HttpResponse response, Throwable throwable) {
@@ -86,12 +86,12 @@ public void endWhenThrown(HttpRequest request, Throwable throwable) {
       }
     }
 
-    public static AdviceLocals fromVirtualFieldContext(HttpRequest request) {
+    public static AdviceScope fromVirtualFieldContext(HttpRequest request) {
       Context context = virtualField.get(request);
       if (context == null) {
         return null;
       }
-      return new AdviceLocals(context, context.makeCurrent());
+      return new AdviceScope(context, context.makeCurrent());
     }
 
     public void storeContextToVirtualField(HttpRequest request) {
@@ -104,28 +104,28 @@ public static class ExecuteAdvice {
 
     @Nullable
     @Advice.OnMethodEnter(suppress = Throwable.class)
-    public static AdviceLocals methodEnter(@Advice.This HttpRequest request) {
+    public static AdviceScope methodEnter(@Advice.This HttpRequest request) {
 
-      AdviceLocals locals = AdviceLocals.fromVirtualFieldContext(request);
-      if (locals != null) {
+      AdviceScope scope = AdviceScope.fromVirtualFieldContext(request);
+      if (scope != null) {
         // span was created by GoogleHttpClientAsyncAdvice instrumentation below
         // (executeAsync ends up calling execute from a separate thread)
         // so make it current and end it in method exit
-        return locals;
+        return scope;
       }
 
-      return AdviceLocals.start(request);
+      return AdviceScope.start(request);
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
     public static void methodExit(
         @Advice.This HttpRequest request,
         @Advice.Return HttpResponse response,
         @Advice.Thrown Throwable throwable,
-        @Advice.Enter @Nullable AdviceLocals locals) {
+        @Advice.Enter @Nullable AdviceScope scope) {
 
-      if (locals != null) {
-        locals.end(request, response, throwable);
+      if (scope != null) {
+        scope.end(request, response, throwable);
       }
     }
   }
@@ -135,9 +135,9 @@ public static class ExecuteAsyncAdvice {
 
     @Nullable
     @Advice.OnMethodEnter(suppress = Throwable.class)
-    public static AdviceLocals methodEnter(@Advice.This HttpRequest request) {
+    public static AdviceScope methodEnter(@Advice.This HttpRequest request) {
 
-      AdviceLocals locals = AdviceLocals.start(request);
+      AdviceScope locals = AdviceScope.start(request);
       if (locals != null) {
         locals.storeContextToVirtualField(request);
       }
@@ -148,10 +148,10 @@ public static AdviceLocals methodEnter(@Advice.This HttpRequest request) {
     public static void methodExit(
         @Advice.This HttpRequest request,
         @Advice.Thrown Throwable throwable,
-        @Advice.Enter @Nullable AdviceLocals locals) {
+        @Advice.Enter @Nullable AdviceScope scope) {
 
-      if (locals != null) {
-        locals.endWhenThrown(request, throwable);
+      if (scope != null) {
+        scope.endWhenThrown(request, throwable);
       }
     }
   }

instrumentation/java-http-client/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/javahttpclient/HttpClientInstrumentation.java

@@ -67,43 +67,43 @@ public void transform(TypeTransformer transformer) {
         HttpClientInstrumentation.class.getName() + "$SendAsyncAdvice");
   }
 
-  public static class AdviceLocals {
+  public static class AdviceScope {
     private final Context context;
     private final Context parentContext;
     private final Scope scope;
     private final CallDepth callDepth;
 
-    private AdviceLocals(Context parentContext, Context context, Scope scope, CallDepth callDepth) {
+    private AdviceScope(Context parentContext, Context context, Scope scope, CallDepth callDepth) {
       this.parentContext = parentContext;
       this.context = context;
       this.scope = scope;
       this.callDepth = callDepth;
     }
 
     @Nullable
-    public static AdviceLocals start(HttpRequest request) {
+    public static AdviceScope start(HttpRequest request) {
       return start(request, null);
     }
 
-    private static AdviceLocals start(HttpRequest request, CallDepth callDepth) {
+    private static AdviceScope start(HttpRequest request, CallDepth callDepth) {
       Context parentContext = currentContext();
       if (!instrumenter().shouldStart(parentContext, request)) {
         return null;
       }
 
       Context context = instrumenter().start(parentContext, request);
-      return new AdviceLocals(parentContext, context, context.makeCurrent(), callDepth);
+      return new AdviceScope(parentContext, context, context.makeCurrent(), callDepth);
     }
 
     public void end(HttpRequest request, HttpResponse<?> response, Throwable throwable) {
       scope.close();
       instrumenter().end(context, request, response, throwable);
     }
 
-    public static AdviceLocals startWithCallDepth(HttpRequest httpRequest) {
+    public static AdviceScope startWithCallDepth(HttpRequest httpRequest) {
       CallDepth callDepth = CallDepth.forClass(HttpClient.class);
       if (callDepth.getAndIncrement() > 0) {
-        return new AdviceLocals(null, null, null, callDepth);
+        return new AdviceScope(null, null, null, callDepth);
       }
       return start(httpRequest, callDepth);
     }
@@ -134,19 +134,19 @@ public static class SendAdvice {
 
     @Nullable
     @Advice.OnMethodEnter(suppress = Throwable.class)
-    public static AdviceLocals methodEnter(@Advice.Argument(value = 0) HttpRequest httpRequest) {
-      return AdviceLocals.start(httpRequest);
+    public static AdviceScope methodEnter(@Advice.Argument(value = 0) HttpRequest httpRequest) {
+      return AdviceScope.start(httpRequest);
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
     public static void methodExit(
         @Advice.Argument(0) HttpRequest httpRequest,
         @Advice.Return HttpResponse<?> httpResponse,
         @Advice.Thrown Throwable throwable,
-        @Advice.Enter @Nullable AdviceLocals locals) {
+        @Advice.Enter @Nullable AdviceScope scope) {
 
-      if (locals != null) {
-        locals.end(httpRequest, httpResponse, throwable);
+      if (scope != null) {
+        scope.end(httpRequest, httpResponse, throwable);
       }
     }
   }
@@ -155,8 +155,8 @@ public static void methodExit(
   public static class SendAsyncAdvice {
 
     @Advice.OnMethodEnter(suppress = Throwable.class)
-    public static AdviceLocals methodEnter(@Advice.Argument(value = 0) HttpRequest httpRequest) {
-      return AdviceLocals.startWithCallDepth(httpRequest);
+    public static AdviceScope methodEnter(@Advice.Argument(value = 0) HttpRequest httpRequest) {
+      return AdviceScope.startWithCallDepth(httpRequest);
     }
 
     @AssignReturned.ToReturned
@@ -165,16 +165,16 @@ public static CompletableFuture<HttpResponse<?>> methodExit(
         @Advice.Argument(value = 0) HttpRequest httpRequest,
         @Advice.Return CompletableFuture<HttpResponse<?>> originalFuture,
         @Advice.Thrown Throwable throwable,
-        @Advice.Enter AdviceLocals locals) {
+        @Advice.Enter AdviceScope scope) {
 
       @SuppressWarnings("UnnecessaryLocalVariable")
       CompletableFuture<HttpResponse<?>> future = originalFuture;
 
-      if (!locals.endWithCallDepth(httpRequest, throwable)) {
+      if (!scope.endWithCallDepth(httpRequest, throwable)) {
         return future;
       }
 
-      return locals.wrapFuture(future, httpRequest);
+      return scope.wrapFuture(future, httpRequest);
     }
   }
 }