code review updates

Author: jaydeluca

instrumentation/ratpack/ratpack-1.7/library/README.md

@@ -1,7 +1,7 @@
 # Library Instrumentation for Ratpack version 1.7 and higher
 
-Provides OpenTelemetry instrumentation for [Ratpack](https://ratpack.io/), enabling HTTP client and server spans and
-metrics.
+Provides OpenTelemetry instrumentation for [Ratpack](https://ratpack.io/), enabling HTTP client and
+server spans and metrics.
 
 ## Quickstart
 
@@ -29,30 +29,38 @@ implementation("io.opentelemetry.instrumentation:opentelemetry-ratpack-1.7:OPENT
 
 ### Usage
 
+The instrumentation library provides implementations for both server and client instrumentation
+that wrap Ratpack components.
+
 ```java
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.instrumentation.ratpack.v1_7.RatpackServerTelemetry;
 import io.opentelemetry.instrumentation.ratpack.v1_7.RatpackClientTelemetry;
 import ratpack.server.RatpackServer;
 import ratpack.http.client.HttpClient;
 
-public class RatpackExample {
-  public static void main(String[] args) throws Exception {
-    // Get an OpenTelemetry instance
-    OpenTelemetry openTelemetry = ...;
+public class RatpackConfiguration {
 
-    // Server instrumentation
+  // Create a server with OpenTelemetry instrumentation
+  public RatpackServer createTracedServer(OpenTelemetry openTelemetry) throws Exception {
     RatpackServerTelemetry serverTelemetry = RatpackServerTelemetry.create(openTelemetry);
-    RatpackServer.start(server -> {
+    return RatpackServer.start(server -> {
       server.registryOf(serverTelemetry::configureRegistry);
       server.handlers(chain ->
         chain.get(ctx -> ctx.render("Hello, World!"))
       );
     });
+  }
 
-    // Client instrumentation
+  // Create an instrumented HttpClient
+  public HttpClient createTracedClient(OpenTelemetry openTelemetry) {
     RatpackClientTelemetry clientTelemetry = RatpackClientTelemetry.create(openTelemetry);
-    HttpClient instrumentedHttpClient = clientTelemetry.instrument(HttpClient.of(spec -> {}));
+    return clientTelemetry.instrument(createClient());
+  }
+
+  // Configuration of the HttpClient goes here
+  private HttpClient createClient() {
+    return HttpClient.of(spec -> {});
   }
 }
 ```

instrumentation/rxjava/rxjava-1.0/library/README.md

@@ -0,0 +1 @@
+classification: internal

instrumentation/rxjava/rxjava-1.0/metadata.yaml

@@ -46,9 +46,7 @@ public class RxJavaExample {
     // All RxJava operations will now be automatically instrumented
     Observable<String> observable = Observable.just("Hello", "World");
     Flowable<String> flowable = Flowable.just("Hello", "World");
-
-    observable.subscribe(System.out::println);
-    flowable.subscribe(System.out::println);
+    ...
   }
 }
 ```