Move SpanFilterBuilder and collaborators to otel package (#490)

* move SpanFilterBuilder and collaborators to otel package * create wrapper in splunk package for SpanFilterBuilder * use splunk filter builder in rum builder (prevent api surface change). * add support for otel-based filter instead of (now) deprecated splunk rum filter. * Update sample-app/build.gradle.kts Co-authored-by: Mateusz Rzeszutek <[email protected]> * Update splunk-otel-android/src/main/java/com/splunk/rum/SplunkRumBuilder.java Co-authored-by: Mateusz Rzeszutek <[email protected]> * remove new config method and keep the status quo for configuring span filtering. --------- Co-authored-by: Mateusz Rzeszutek <[email protected]>
open-telemetry · Mar 13, 2023 · a8636c0 · a8636c0
1 parent d344552
commit a8636c0
Show file tree

Hide file tree

Showing 7 changed files with 166 additions and 50 deletions.
diff --git a/splunk-otel-android/src/main/java/com/splunk/rum/SpanFilterBuilder.java b/splunk-otel-android/src/main/java/com/splunk/rum/SpanFilterBuilder.java
@@ -18,24 +18,14 @@
 
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.sdk.trace.export.SpanExporter;
-import java.util.HashMap;
-import java.util.Map;
 import java.util.function.Function;
 import java.util.function.Predicate;
 
-/**
- * Allows modification of span data before it is sent to the exporter. Spans can be modified or
- * entirely rejected from export.
- */
+/** Delegating wrapper around otel SpanFilterBuilder. */
 public final class SpanFilterBuilder {
 
-    private Predicate<String> rejectSpanNamesPredicate = spanName -> false;
-    private final Map<AttributeKey<?>, Predicate<?>> rejectSpanAttributesPredicates =
-            new HashMap<>();
-    private final Map<AttributeKey<?>, Function<?, ?>> spanAttributeReplacements = new HashMap<>();
-
-    SpanFilterBuilder() {}
-
+    private final io.opentelemetry.rum.internal.SpanFilterBuilder delegate =
+            new io.opentelemetry.rum.internal.SpanFilterBuilder();
     /**
      * Remove matching spans from the exporter pipeline.
      *
@@ -46,7 +36,7 @@ public final class SpanFilterBuilder {
      * @return {@code this}.
      */
     public SpanFilterBuilder rejectSpansByName(Predicate<String> spanNamePredicate) {
-        rejectSpanNamesPredicate = rejectSpanNamesPredicate.or(spanNamePredicate);
+        delegate.rejectSpansByName(spanNamePredicate);
         return this;
     }
 
@@ -63,13 +53,7 @@ public SpanFilterBuilder rejectSpansByName(Predicate<String> spanNamePredicate)
      */
     public <T> SpanFilterBuilder rejectSpansByAttributeValue(
             AttributeKey<T> attributeKey, Predicate<? super T> attributeValuePredicate) {
-
-        rejectSpanAttributesPredicates.compute(
-                attributeKey,
-                (k, oldValue) ->
-                        oldValue == null
-                                ? attributeValuePredicate
-                                : ((Predicate<T>) oldValue).or(attributeValuePredicate));
+        delegate.rejectSpansByAttributeValue(attributeKey, attributeValuePredicate);
         return this;
     }
 
@@ -83,7 +67,8 @@ public <T> SpanFilterBuilder rejectSpansByAttributeValue(
      * @return {@code this}.
      */
     public <T> SpanFilterBuilder removeSpanAttribute(AttributeKey<T> attributeKey) {
-        return removeSpanAttribute(attributeKey, value -> true);
+        delegate.removeSpanAttribute(attributeKey);
+        return this;
     }
 
     /**
@@ -99,9 +84,8 @@ public <T> SpanFilterBuilder removeSpanAttribute(AttributeKey<T> attributeKey) {
      */
     public <T> SpanFilterBuilder removeSpanAttribute(
             AttributeKey<T> attributeKey, Predicate<? super T> attributeValuePredicate) {
-
-        return replaceSpanAttribute(
-                attributeKey, old -> attributeValuePredicate.test(old) ? null : old);
+        delegate.removeSpanAttribute(attributeKey, attributeValuePredicate);
+        return this;
     }
 
     /**
@@ -119,30 +103,15 @@ public <T> SpanFilterBuilder removeSpanAttribute(
      */
     public <T> SpanFilterBuilder replaceSpanAttribute(
             AttributeKey<T> attributeKey, Function<? super T, ? extends T> attributeValueModifier) {
-
-        spanAttributeReplacements.compute(
-                attributeKey,
-                (k, oldValue) ->
-                        oldValue == null
-                                ? attributeValueModifier
-                                : ((Function<T, T>) oldValue).andThen(attributeValueModifier));
+        delegate.replaceSpanAttribute(attributeKey, attributeValueModifier);
         return this;
     }
 
-    Function<SpanExporter, SpanExporter> build() {
-        // make a copy so that the references from the builder are not included in the returned
-        // function
-        Predicate<String> rejectSpanNamesPredicate = this.rejectSpanNamesPredicate;
-        Map<AttributeKey<?>, Predicate<?>> rejectSpanAttributesPredicates =
-                new HashMap<>(this.rejectSpanAttributesPredicates);
-        Map<AttributeKey<?>, Function<?, ?>> spanAttributeReplacements =
-                new HashMap<>(this.spanAttributeReplacements);
+    io.opentelemetry.rum.internal.SpanFilterBuilder getDelegate() {
+        return delegate;
+    }
 
-        return exporter ->
-                new SpanDataModifier(
-                        exporter,
-                        rejectSpanNamesPredicate,
-                        rejectSpanAttributesPredicates,
-                        spanAttributeReplacements);
+    public Function<SpanExporter, SpanExporter> build() {
+        return delegate.build();
     }
 }
diff --git a/splunk-otel-android/src/main/java/com/splunk/rum/StandardAttributes.java b/splunk-otel-android/src/main/java/com/splunk/rum/StandardAttributes.java
@@ -18,6 +18,7 @@
 
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.rum.internal.SpanFilterBuilder;
 import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
 
 /**

diff --git a/...java/com/splunk/rum/ModifiedSpanData.java → ...emetry/rum/internal/ModifiedSpanData.java b/...java/com/splunk/rum/ModifiedSpanData.java → ...emetry/rum/internal/ModifiedSpanData.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.splunk.rum;
+package io.opentelemetry.rum.internal;
 
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.sdk.trace.data.DelegatingSpanData;

diff --git a/...java/com/splunk/rum/SpanDataModifier.java → ...emetry/rum/internal/SpanDataModifier.java b/...java/com/splunk/rum/SpanDataModifier.java → ...emetry/rum/internal/SpanDataModifier.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.splunk.rum;
+package io.opentelemetry.rum.internal;
 
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;

diff --git a/splunk-otel-android/src/main/java/io/opentelemetry/rum/internal/SpanFilterBuilder.java b/splunk-otel-android/src/main/java/io/opentelemetry/rum/internal/SpanFilterBuilder.java
@@ -0,0 +1,146 @@
+/*
+ * Copyright Splunk Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.opentelemetry.rum.internal;
+
+import io.opentelemetry.api.common.AttributeKey;
+import io.opentelemetry.sdk.trace.export.SpanExporter;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.function.Function;
+import java.util.function.Predicate;
+
+/**
+ * Allows modification of span data before it is sent to the exporter. Spans can be modified or
+ * entirely rejected from export.
+ */
+public final class SpanFilterBuilder {
+
+    private Predicate<String> rejectSpanNamesPredicate = spanName -> false;
+    private final Map<AttributeKey<?>, Predicate<?>> rejectSpanAttributesPredicates =
+            new HashMap<>();
+    private final Map<AttributeKey<?>, Function<?, ?>> spanAttributeReplacements = new HashMap<>();
+
+    /**
+     * Remove matching spans from the exporter pipeline.
+     *
+     * <p>Spans with names that match the {@code spanNamePredicate} will not be exported.
+     *
+     * @param spanNamePredicate A function that returns true if a span with passed name should be
+     *     rejected.
+     * @return {@code this}.
+     */
+    public SpanFilterBuilder rejectSpansByName(Predicate<String> spanNamePredicate) {
+        rejectSpanNamesPredicate = rejectSpanNamesPredicate.or(spanNamePredicate);
+        return this;
+    }
+
+    /**
+     * Remove matching spans from the exporter pipeline.
+     *
+     * <p>Any span that contains an attribute with key {@code attributeKey} and value matching the
+     * {@code attributeValuePredicate} will not be exported.
+     *
+     * @param attributeKey An attribute key to match.
+     * @param attributeValuePredicate A function that returns true if a span containing an attribute
+     *     with matching value should be rejected.
+     * @return {@code this}.
+     */
+    public <T> SpanFilterBuilder rejectSpansByAttributeValue(
+            AttributeKey<T> attributeKey, Predicate<? super T> attributeValuePredicate) {
+
+        rejectSpanAttributesPredicates.compute(
+                attributeKey,
+                (k, oldValue) ->
+                        oldValue == null
+                                ? attributeValuePredicate
+                                : ((Predicate<T>) oldValue).or(attributeValuePredicate));
+        return this;
+    }
+
+    /**
+     * Modify span data before it enters the exporter pipeline.
+     *
+     * <p>Any attribute with key {@code attributeKey} and will be removed from the span before it is
+     * exported.
+     *
+     * @param attributeKey An attribute key to match.
+     * @return {@code this}.
+     */
+    public <T> SpanFilterBuilder removeSpanAttribute(AttributeKey<T> attributeKey) {
+        return removeSpanAttribute(attributeKey, value -> true);
+    }
+
+    /**
+     * Modify span data before it enters the exporter pipeline.
+     *
+     * <p>Any attribute with key {@code attributeKey} and value matching the {@code
+     * attributeValuePredicate} will be removed from the span before it is exported.
+     *
+     * @param attributeKey An attribute key to match.
+     * @param attributeValuePredicate A function that returns true if an attribute with matching
+     *     value should be removed from the span.
+     * @return {@code this}.
+     */
+    public <T> SpanFilterBuilder removeSpanAttribute(
+            AttributeKey<T> attributeKey, Predicate<? super T> attributeValuePredicate) {
+
+        return replaceSpanAttribute(
+                attributeKey, old -> attributeValuePredicate.test(old) ? null : old);
+    }
+
+    /**
+     * Modify span data before it enters the exporter pipeline.
+     *
+     * <p>The value of any attribute with key {@code attributeKey} will be passed to the {@code
+     * attributeValueModifier} function. The value returned by the function will replace the
+     * original value. When the modifier function returns {@code null} the attribute will be removed
+     * from the span.
+     *
+     * @param attributeKey An attribute key to match.
+     * @param attributeValueModifier A function that receives the old attribute value and returns
+     *     the new one.
+     * @return {@code this}.
+     */
+    public <T> SpanFilterBuilder replaceSpanAttribute(
+            AttributeKey<T> attributeKey, Function<? super T, ? extends T> attributeValueModifier) {
+
+        spanAttributeReplacements.compute(
+                attributeKey,
+                (k, oldValue) ->
+                        oldValue == null
+                                ? attributeValueModifier
+                                : ((Function<T, T>) oldValue).andThen(attributeValueModifier));
+        return this;
+    }
+
+    public Function<SpanExporter, SpanExporter> build() {
+        // make a copy so that the references from the builder are not included in the returned
+        // function
+        Predicate<String> rejectSpanNamesPredicate = this.rejectSpanNamesPredicate;
+        Map<AttributeKey<?>, Predicate<?>> rejectSpanAttributesPredicates =
+                new HashMap<>(this.rejectSpanAttributesPredicates);
+        Map<AttributeKey<?>, Function<?, ?>> spanAttributeReplacements =
+                new HashMap<>(this.spanAttributeReplacements);
+
+        return exporter ->
+                new SpanDataModifier(
+                        exporter,
+                        rejectSpanNamesPredicate,
+                        rejectSpanAttributesPredicates,
+                        spanAttributeReplacements);
+    }
+}
diff --git a/.../com/splunk/rum/ModifiedSpanDataTest.java → ...ry/rum/internal/ModifiedSpanDataTest.java b/.../com/splunk/rum/ModifiedSpanDataTest.java → ...ry/rum/internal/ModifiedSpanDataTest.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.splunk.rum;
+package io.opentelemetry.rum.internal;
 
 import static io.opentelemetry.api.common.AttributeKey.stringKey;
 import static java.util.Collections.emptyList;

diff --git a/.../com/splunk/rum/SpanDataModifierTest.java → ...ry/rum/internal/SpanDataModifierTest.java b/.../com/splunk/rum/SpanDataModifierTest.java → ...ry/rum/internal/SpanDataModifierTest.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.splunk.rum;
+package io.opentelemetry.rum.internal;
 
 import static io.opentelemetry.api.common.AttributeKey.longKey;
 import static io.opentelemetry.api.common.AttributeKey.stringKey;