add otel and segment usage adapters, add all appropriate feedback

rvowles · rvowles · commit 55b08f6363a1 · 2024-08-04T21:45:08.000+12:00
diff --git a/.github/workflows/java.yaml b/.github/workflows/java.yaml
@@ -14,5 +14,9 @@ jobs:
           java-version: '11'
           distribution: 'temurin'
           cache: maven
-      - name: Build with Maven
-        run: MVN_OPTS="--batch-mode --quiet" sh ./build_all_and_test.sh
+      - name: Install tiles
+        run: cd support && mvn -f pom-tiles.xml install
+      - name: Install support composites
+        run: cd support && mvn install
+      - name: All other things
+        run: mvn install
diff --git a/build_alL_and_test.sh b/build_alL_and_test.sh
@@ -1,4 +1,6 @@
 #!/bin/sh
+set -x
+export MVN_OPTS="--batch-mode --quiet"
 MAVEN_OPTS=${MVN_OPTS:-"-T4C"}
 cd support && mvn -f pom-tiles.xml install && mvn install && cd .. && mvn $MAVEN_OPTS clean install
 
diff --git a/client-java-api/pom.xml b/client-java-api/pom.xml
@@ -128,7 +128,7 @@
         <configuration>
           <filtering>false</filtering>
           <tiles>
-            <tile>io.featurehub.sdk.tiles:tile-java8:[1.1,2)</tile>
+            <tile>io.featurehub.sdk.tiles:tile-java11:[1.1,2)</tile>
             <tile>io.featurehub.sdk.tiles:tile-release:[1.1,2)</tile>
           </tiles>
         </configuration>
diff --git a/client-java-core/pom.xml b/client-java-core/pom.xml
@@ -88,7 +88,7 @@
         <configuration>
           <filtering>false</filtering>
           <tiles>
-            <tile>io.featurehub.sdk.tiles:tile-java8:[1.1,2)</tile>
+            <tile>io.featurehub.sdk.tiles:tile-java11:[1.1,2)</tile>
             <tile>io.featurehub.sdk.tiles:tile-release:[1.1,2)</tile>
           </tiles>
         </configuration>
diff --git a/client-java-core/src/main/java/io/featurehub/client/BaseClientContext.java b/client-java-core/src/main/java/io/featurehub/client/BaseClientContext.java
@@ -107,6 +107,21 @@ public ClientContext attrs(String name, List<String> values) {
     return this;
   }
 
+  @Override
+  public ClientContext attrs(Map<String, List<String>> values) {
+    attributes.clear();
+    attributes.putAll(values);
+
+    return this;
+  }
+
+  @Override
+  public ClientContext attrsMerge(Map<String, List<String>> values) {
+    attributes.putAll(values);
+
+    return this;
+  }
+
   @Override
   public void used(@NotNull String key, @NotNull UUID id, @Nullable Object val,
                              @NotNull FeatureValueType valueType) {
diff --git a/client-java-core/src/main/java/io/featurehub/client/ClientContext.java b/client-java-core/src/main/java/io/featurehub/client/ClientContext.java
@@ -25,6 +25,9 @@ public interface ClientContext {
   ClientContext attr(String name, String value);
   ClientContext attrs(String name, List<String> values);
 
+  ClientContext attrs(Map<String, List<String>> values);
+  ClientContext attrsMerge(Map<String, List<String>> values);
+
   ClientContext clear();
 
   @Nullable String getAttr(@NotNull String name);
diff --git a/client-java-core/src/main/java/io/featurehub/client/usage/UsageAdapter.java b/client-java-core/src/main/java/io/featurehub/client/usage/UsageAdapter.java
@@ -1,5 +1,6 @@
 package io.featurehub.client.usage;
 
+import io.featurehub.client.ClientContext;
 import io.featurehub.client.FeatureRepository;
 import io.featurehub.client.RepositoryEventHandler;
 
diff --git a/client-java-core/src/main/java/io/featurehub/client/usage/UsageEvent.java b/client-java-core/src/main/java/io/featurehub/client/usage/UsageEvent.java
@@ -41,7 +41,7 @@ public UsageEvent(@Nullable String userKey, @Nullable Map<String, Object> additi
   }
 
   @NotNull
-  public Map<String, Object> toMap() {
+  public Map<String, ?> toMap() {
     return additionalParams;
   }
 
diff --git a/client-java-core/src/main/java/io/featurehub/client/usage/UsageEventWithFeature.java b/client-java-core/src/main/java/io/featurehub/client/usage/UsageEventWithFeature.java
@@ -41,7 +41,7 @@ public UsageEventWithFeature(@NotNull FeatureHubUsageValue feature, @Nullable Ma
       m.putAll(attributes);
     }
     m.put("feature", feature.key);
-    m.put("value", feature.id);
+    m.put("value", feature.value);
     m.put("id", feature.id);
 
     return Collections.unmodifiableMap(m);
diff --git a/client-java-core/src/main/java/io/featurehub/client/usage/UsageFeaturesCollection.java b/client-java-core/src/main/java/io/featurehub/client/usage/UsageFeaturesCollection.java
@@ -25,7 +25,7 @@ public UsageFeaturesCollection() {}
   void ready() {}
 
   @Override
-  @NotNull public Map<String, Object> toMap() {
+  @NotNull public Map<String, ?> toMap() {
     Map<String, Object> m = new HashMap<>(super.toMap());
     featureValues.forEach((fv) -> m.put(fv.key, fv.value));
 
diff --git a/client-java-core/src/main/java/io/featurehub/client/usage/UsageFeaturesCollectionContext.java b/client-java-core/src/main/java/io/featurehub/client/usage/UsageFeaturesCollectionContext.java
@@ -25,7 +25,7 @@ public void setAttributes(Map<String, List<String>> attributes) {
   }
 
   @Override
-  @NotNull public Map<String, Object> toMap() {
+  @NotNull public Map<String, ?> toMap() {
     Map<String, Object> m = new HashMap<>(super.toMap());
 
     m.putAll(attributes);
diff --git a/client-java-jersey/pom.xml b/client-java-jersey/pom.xml
@@ -161,7 +161,7 @@
         <configuration>
           <filtering>false</filtering>
           <tiles>
-            <tile>io.featurehub.sdk.tiles:tile-java8:[1.1,2)</tile>
+            <tile>io.featurehub.sdk.tiles:tile-java11:[1.1,2)</tile>
             <tile>io.featurehub.sdk.tiles:tile-release:[1.1,2)</tile>
             <tile>io.featurehub.sdk.tiles:tile-sdk:[1.1-SNAPSHOT,2)</tile>
           </tiles>
diff --git a/client-java-jersey3/pom.xml b/client-java-jersey3/pom.xml
@@ -182,7 +182,7 @@
         <configuration>
           <filtering>false</filtering>
           <tiles>
-            <tile>io.featurehub.sdk.tiles:tile-java8:[1.1,2)</tile>
+            <tile>io.featurehub.sdk.tiles:tile-java11:[1.1,2)</tile>
             <tile>io.featurehub.sdk.tiles:tile-release:[1.1,2)</tile>
             <tile>io.featurehub.sdk.tiles:tile-sdk:[1.1-SNAPSHOT,2)</tile>
           </tiles>
diff --git a/client-java-okhttp/pom.xml b/client-java-okhttp/pom.xml
@@ -100,7 +100,7 @@
         <configuration>
           <filtering>false</filtering>
           <tiles>
-            <tile>io.featurehub.sdk.tiles:tile-java8:[1.1,2)</tile>
+            <tile>io.featurehub.sdk.tiles:tile-java11:[1.1,2)</tile>
             <tile>io.featurehub.sdk.tiles:tile-release:[1.1,2)</tile>
             <tile>io.featurehub.sdk.tiles:tile-sdk:[1.1-SNAPSHOT,2)</tile>
           </tiles>
diff --git a/examples/todo-java/.gitignore b/examples/todo-java/.gitignore
@@ -60,3 +60,4 @@ fabric.properties
 /swagger-backend/app/app.js.map
 /swagger-backend/app/generated-interface.js
 /swagger-backend/app/generated-interface.js.map
+/opentelemetry-javaagent.jar
diff --git a/examples/todo-java/pom.xml b/examples/todo-java/pom.xml
@@ -45,7 +45,32 @@
     <dependency>
       <groupId>io.featurehub.sdk.java</groupId>
       <artifactId>segment-usageadapter</artifactId>
-      <version>1.1-SNAPSHOT</version>
+      <version>[1.1-SNAPSHOT, 2)</version>
+    </dependency>
+
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-api</artifactId>
+      <version>1.40.0</version>
+      <scope>provided</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>io.opentelemetry.javaagent.instrumentation</groupId>
+      <artifactId>opentelemetry-javaagent-jaxrs-3.0-jersey-3.0</artifactId>
+      <version>2.6.0-alpha</version>
+    </dependency>
+
+    <dependency>
+      <groupId>io.opentelemetry.javaagent.instrumentation</groupId>
+      <artifactId>opentelemetry-javaagent-grizzly-2.3</artifactId>
+      <version>2.6.0-alpha</version>
+    </dependency>
+
+    <dependency>
+      <groupId>io.featurehub.sdk.java</groupId>
+      <artifactId>opentelemetry-usageadapter</artifactId>
+      <version>[1.1-SNAPSHOT, 2)</version>
     </dependency>
 
     <dependency>
@@ -188,7 +213,7 @@
         <configuration>
           <filtering>false</filtering>
           <tiles>
-            <tile>io.featurehub.sdk.tiles:tile-java8:[1.1,2)</tile>
+            <tile>io.featurehub.sdk.tiles:tile-java11:[1.1,2)</tile>
           </tiles>
         </configuration>
       </plugin>
diff --git a/examples/todo-java/src/main/java/todo/backend/FeatureHub.java b/examples/todo-java/src/main/java/todo/backend/FeatureHub.java
@@ -2,9 +2,11 @@
 
 import io.featurehub.client.ClientContext;
 import io.featurehub.client.FeatureHubConfig;
+import io.featurehub.sdk.usageadapter.segment.SegmentAnalyticsSource;
 
 import java.util.concurrent.Future;
 
 public interface FeatureHub {
   FeatureHubConfig getConfig();
+  SegmentAnalyticsSource segmentAnalytics();
 }
diff --git a/examples/todo-java/src/main/java/todo/backend/FeatureHubClientContextThreadLocal.java b/examples/todo-java/src/main/java/todo/backend/FeatureHubClientContextThreadLocal.java
@@ -0,0 +1,19 @@
+package todo.backend;
+
+import io.featurehub.client.ClientContext;
+
+public class FeatureHubClientContextThreadLocal {
+  private static final ThreadLocal<ClientContext> ctx = new ThreadLocal<>();
+
+  public static void set(ClientContext context) {
+    ctx.set(context);
+  }
+
+  public static ClientContext get() {
+    return ctx.get();
+  }
+
+  public static void clear() {
+    ctx.remove();
+  }
+}
diff --git a/examples/todo-java/src/main/java/todo/backend/FeatureHubSource.java b/examples/todo-java/src/main/java/todo/backend/FeatureHubSource.java
@@ -4,13 +4,20 @@
 import cd.connect.app.config.DeclaredConfigResolver;
 import cd.connect.lifecycle.ApplicationLifecycleManager;
 import cd.connect.lifecycle.LifecycleStatus;
+import com.segment.analytics.messages.Message;
 import io.featurehub.client.*;
 import io.featurehub.okhttp.RestClient;
 import io.featurehub.client.edge.EdgeRetryer;
 import io.featurehub.client.interceptor.SystemPropertyValueInterceptor;
 import io.featurehub.client.jersey.JerseySSEClient;
 import io.featurehub.okhttp.SSEClient;
-import io.featurehub.sdk.usageadapter.segment.SegmentUsageAdapter;
+import io.featurehub.sdk.usageadapter.opentelemetry.OpenTelemetryUsagePlugin;
+import io.featurehub.sdk.usageadapter.segment.SegmentAnalyticsSource;
+import io.featurehub.sdk.usageadapter.segment.SegmentMessageTransformer;
+import io.featurehub.sdk.usageadapter.segment.SegmentUsagePlugin;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.List;
 
 public class FeatureHubSource implements FeatureHub {
   @ConfigKey("feature-service.host")
@@ -26,6 +33,8 @@ public class FeatureHubSource implements FeatureHub {
   @ConfigKey("feature-service.poll-interval")
   Integer pollInterval = 1000; // in milliseconds
 
+  @Nullable SegmentAnalyticsSource segmentAnalyticsSource;
+
   private final FeatureHubConfig config;
 
   public FeatureHubSource() {
@@ -35,9 +44,16 @@ public FeatureHubSource() {
       .registerValueInterceptor(true, new SystemPropertyValueInterceptor());
 
     if (!segmentWriteKey.isEmpty()) {
-      config.registerUsagePlugin(new SegmentUsageAdapter(segmentWriteKey));
+      final SegmentUsagePlugin segmentUsagePlugin = new SegmentUsagePlugin(segmentWriteKey,
+        List.of(new SegmentMessageTransformer(Message.Type.values(),
+          FeatureHubClientContextThreadLocal::get, false, true)));
+      config.registerUsagePlugin(segmentUsagePlugin);
+      segmentAnalyticsSource = segmentUsagePlugin;
     }
 
+    // this won't do anything if otel isn't found or configured
+    config.registerUsagePlugin(new OpenTelemetryUsagePlugin());
+
     // Do this if you wish to force the connection to stay open.
     if (clientSdk.equals("jersey3")) {
       final JerseySSEClient jerseyClient = new JerseySSEClient(config.getInternalRepository(),
@@ -68,6 +84,11 @@ public FeatureHubConfig getConfig() {
     return config;
   }
 
+  @Override
+  public SegmentAnalyticsSource segmentAnalytics() {
+    return segmentAnalyticsSource;
+  }
+
   public void close() {
     config.close();
   }
diff --git a/examples/todo-java/src/main/java/todo/backend/resources/FeatureAnalyticsFilter.java b/examples/todo-java/src/main/java/todo/backend/resources/FeatureAnalyticsFilter.java
@@ -11,6 +11,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import todo.backend.FeatureHub;
+import todo.backend.FeatureHubClientContextThreadLocal;
 import todo.backend.UsageRequestMeasurement;
 
 import java.io.IOException;
@@ -47,6 +48,8 @@ public void filter(ContainerRequestContext requestContext, ContainerResponseCont
     Long start = (Long) requestContext.getProperty("startTime");
     ClientContext context = (ClientContext) requestContext.getProperty("context");
 
+    FeatureHubClientContextThreadLocal.clear();
+
     if (start != null && context != null) {
       long duration = System.currentTimeMillis() - start;
 
diff --git a/examples/todo-java/src/main/java/todo/backend/resources/TodoResource.java b/examples/todo-java/src/main/java/todo/backend/resources/TodoResource.java
@@ -1,7 +1,6 @@
 package todo.backend.resources;
 
 import io.featurehub.client.ClientContext;
-import io.featurehub.client.ThreadLocalContext;
 import jakarta.inject.Inject;
 import jakarta.ws.rs.NotFoundException;
 import jakarta.ws.rs.WebApplicationException;
@@ -10,6 +9,8 @@
 import org.slf4j.LoggerFactory;
 import todo.api.TodoService;
 import todo.backend.FeatureHub;
+import todo.backend.FeatureHubClientContextThreadLocal;
+import com.segment.analytics.messages.IdentifyMessage;
 import todo.model.Todo;
 
 import java.util.List;
@@ -21,12 +22,12 @@
 
 public class TodoResource implements TodoService {
   private static final Logger log = LoggerFactory.getLogger(TodoResource.class);
-  private final FeatureHub config;
+  private final FeatureHub featureHub;
   Map<String, Map<String, Todo>> todos = new ConcurrentHashMap<>();
 
   @Inject
   public TodoResource(FeatureHub config) {
-    this.config = config;
+    this.featureHub = config;
     log.info("created");
   }
 
@@ -78,7 +79,21 @@ private String processTitle(ClientContext fhClient, String title) {
 
   @NotNull private ClientContext fhClient(String user) {
     try {
-      return config.getConfig().newContext().userKey(user).build().get();
+      final ClientContext context = featureHub.getConfig().newContext()
+        .userKey(user)
+        .attrs("mine", List.of("yours", "his"))
+        .build().get();
+
+      FeatureHubClientContextThreadLocal.set(context);
+
+      if (featureHub.segmentAnalytics() != null) {
+        // this should have the current user's details augmented into it
+        featureHub.segmentAnalytics().getAnalytics().enqueue(IdentifyMessage.builder().userId(user));
+      }
+
+      context.feature("SUBMIT_COLOR_BUTTON").isSet();
+
+      return context;
     } catch (Exception e) {
       log.error("Unable to get context!", e);
       throw new WebApplicationException(e);
diff --git a/usage-adapters/featurehub-opentelemetry-adapter/.editorconfig b/usage-adapters/featurehub-opentelemetry-adapter/.editorconfig
@@ -0,0 +1,19 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+indent_style = space
+
+[*.adoc]
+trim_trailing_whitespace = false
+indent_style = space
+
diff --git a/usage-adapters/featurehub-opentelemetry-adapter/README.adoc b/usage-adapters/featurehub-opentelemetry-adapter/README.adoc
@@ -0,0 +1,19 @@
+== FeatureHub Opentelemetry Usage Plugin for Java
+
+The purpose of this usage plugin is to allow Usage tracking events to be attached as Span events in OpenTelemetry. 
+
+This allows you to view spans in your OpenTelemetry system and see what features were evaluated, and what their values were. 
+
+If you record a custom FeatureHub Usage event, it will be translated as long as it implements the `UsageEventName` interface. All attributes are logged with a prefix, which defaults to `featurehub.` - but this can be changed on construction.
+
+The plugin does not specify a version of the OpenTelemetry libraries to use,
+it expects your application will include and configure all of these.
+
+A simple configuration, it can be used as:
+
+[source,java]
+----
+config.registerUsagePlugin(new OpenTelemetryUsagePlugin());
+----
+
+It is safe to include even if OpenTelemetry is not enabled on your system because it will check it has a valid setup before attempting to log to your OpenTelemetry system.
diff --git a/usage-adapters/featurehub-opentelemetry-adapter/pom.xml b/usage-adapters/featurehub-opentelemetry-adapter/pom.xml
diff --git a/usage-adapters/featurehub-opentelemetry-adapter/src/main/java/io/featurehub/sdk/usageadapter/opentelemetry/OpenTelemetryUsagePlugin.java b/usage-adapters/featurehub-opentelemetry-adapter/src/main/java/io/featurehub/sdk/usageadapter/opentelemetry/OpenTelemetryUsagePlugin.java
diff --git a/usage-adapters/featurehub-segment-adapter/.editorconfig b/usage-adapters/featurehub-segment-adapter/.editorconfig
diff --git a/usage-adapters/featurehub-segment-adapter/README.adoc b/usage-adapters/featurehub-segment-adapter/README.adoc
diff --git a/usage-adapters/featurehub-segment-adapter/pom.xml b/usage-adapters/featurehub-segment-adapter/pom.xml
diff --git a/usage-adapters/featurehub-segment-adapter/src/main/java/io/featurehub/sdk/usageadapter/segment/SegmentAnalyticsSource.java b/usage-adapters/featurehub-segment-adapter/src/main/java/io/featurehub/sdk/usageadapter/segment/SegmentAnalyticsSource.java
diff --git a/usage-adapters/featurehub-segment-adapter/src/main/java/io/featurehub/sdk/usageadapter/segment/SegmentMessageTransformer.java b/usage-adapters/featurehub-segment-adapter/src/main/java/io/featurehub/sdk/usageadapter/segment/SegmentMessageTransformer.java
diff --git a/usage-adapters/featurehub-segment-adapter/src/main/java/io/featurehub/sdk/usageadapter/segment/SegmentUsageAdapter.java b/usage-adapters/featurehub-segment-adapter/src/main/java/io/featurehub/sdk/usageadapter/segment/SegmentUsageAdapter.java
diff --git a/usage-adapters/featurehub-segment-adapter/src/main/java/io/featurehub/sdk/usageadapter/segment/SegmentUsagePlugin.java b/usage-adapters/featurehub-segment-adapter/src/main/java/io/featurehub/sdk/usageadapter/segment/SegmentUsagePlugin.java
diff --git a/usage-adapters/pom.xml b/usage-adapters/pom.xml

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public UsageEvent(@Nullable String userKey, @Nullable Map<String, Object> additi`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`@NotNull`
`44`		`- public Map<String, Object> toMap() {`
	`44`	`+ public Map<String, ?> toMap() {`
`45`	`45`	`return additionalParams;`
`46`	`46`	`}`
`47`	`47`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public UsageEventWithFeature(@NotNull FeatureHubUsageValue feature, @Nullable Ma`
`41`	`41`	`m.putAll(attributes);`
`42`	`42`	`}`
`43`	`43`	`m.put("feature", feature.key);`
`44`		`- m.put("value", feature.id);`
	`44`	`+ m.put("value", feature.value);`
`45`	`45`	`m.put("id", feature.id);`
`46`	`46`
`47`	`47`	`return Collections.unmodifiableMap(m);`