Replace/extend resource dest. with service target.{name.type}

CHANGELOG.asciidoc

@@ -28,6 +28,7 @@ endif::[]
 * Struts action invocations via an action chain result start a new span - {pull}2513[#2513]
 * Added official support for Elasticsearch Java API client - {pull}2211[#2211]
 * Added the ability to make spans non-discardable through the public API and the OpenTelemetry bridge - {pull}2632[#2632]
+* Added support for the new service target fields - {pull}2578[#2578]
 
 [float]
 ===== Bug fixes

apm-agent-api/src/main/java/co/elastic/apm/api/AbstractSpanImpl.java

@@ -179,6 +179,10 @@ protected void doSetDestinationService(@Nullable String resource) {
         // co.elastic.apm.agent.pluginapi.AbstractSpanInstrumentation.SetDestinationServiceInstrumentation
     }
 
+    protected void doSetServiceTarget(@Nullable String type, @Nullable String name) {
+        // co.elastic.apm.agent.pluginapi.AbstractSpanInstrumentation.SetServiceTargetInstrumentation
+    }
+
     protected void doSetNonDiscardable() {
         // co.elastic.apm.agent.pluginapi.AbstractSpanInstrumentation.SetNonDiscardableInstrumentation
     }

apm-agent-api/src/main/java/co/elastic/apm/api/NoopSpan.java

@@ -178,6 +178,12 @@ public Span setDestinationService(@Nullable String resource) {
         return this;
     }
 
+    @Nonnull
+    @Override
+    public Span setServiceTarget(@Nullable String type, @Nullable String name) {
+        return this;
+    }
+
     @Override
     @Nonnull
     public Span setNonDiscardable() {

apm-agent-api/src/main/java/co/elastic/apm/api/NoopTransaction.java

@@ -243,6 +243,11 @@ public Span setDestinationService(@Nullable String resource) {
 
     @Nonnull
     @Override
+    public Span setServiceTarget(@Nullable String type, @Nullable String name) {
+        return this;
+    }
+
+    @Nonnull
     public Span setNonDiscardable() {
         return this;
     }

apm-agent-api/src/main/java/co/elastic/apm/api/Span.java

@@ -463,10 +463,24 @@ public interface Span {
      * @param resource the string representation of the downstream service. Will be used to override automatically
      *                 inferred value, even if {@code null}.
      * @return this span
+     *
+     * @deprecated use {@link #setServiceTarget(String, String)} instead
      */
+    @Deprecated
     @Nonnull
     Span setDestinationService(@Nullable String resource);
 
+    /**
+     * Provides a way to manually set the {@code service.target.type} and {@code service.target.name} fields that are used
+     * for service maps and the identification of downstream services. Those fields are ignored for apm-server before 8.3.
+     *
+     * @param type service target type, usually same value as {@code span.subtype}
+     * @param name service target name: value depends on backend type, for databases it's usually the database name
+     * @return this span
+     */
+    @Nonnull
+    Span setServiceTarget(@Nullable String type, @Nullable String name);
+
     /**
      * Makes this span non-discardable.
      * In some cases, spans may be discarded, for example if {@code span_min_duration} config option is set and the span does not exceed
@@ -479,4 +493,5 @@ public interface Span {
      */
     @Nonnull
     Span setNonDiscardable();
+
 }

apm-agent-api/src/main/java/co/elastic/apm/api/SpanImpl.java

@@ -126,6 +126,13 @@ public Span setDestinationService(@Nullable String resource) {
         return this;
     }
 
+    @Nonnull
+    @Override
+    public Span setServiceTarget(@Nullable String type, @Nullable String name) {
+        doSetServiceTarget(type, name);
+        return this;
+    }
+
     @Nonnull
     @Override
     public Span setNonDiscardable() {

apm-agent-api/src/main/java/co/elastic/apm/api/TransactionImpl.java

@@ -201,6 +201,16 @@ public Transaction setDestinationService(@Nullable String resource) {
         throw new UnsupportedOperationException();
     }
 
+
+    /**
+     * @deprecated - used only for {@link co.elastic.apm.api.Span}
+     */
+    @Nonnull
+    @Override
+    public Span setServiceTarget(@Nullable String type, @Nullable String name) {
+        throw new UnsupportedOperationException();
+    }
+
     @Nonnull
     @Override
     public Span setNonDiscardable() {

apm-agent-core/src/main/java/co/elastic/apm/agent/impl/context/Destination.java

@@ -141,17 +141,8 @@ private void withAddress(CharSequence address, int start, int end) {
         }
     }
 
-    /**
-     * Information about the service related to this destination.
-     */
-    private final Service service = new Service();
-
-    public Service getService() {
-        return service;
-    }
-
     public boolean hasContent() {
-        return address.length() > 0 || port > 0 || service.hasContent();
+        return address.length() > 0 || port > 0;
     }
 
     @Override
@@ -160,7 +151,6 @@ public void resetState() {
         addressSetByUser = false;
         port = 0;
         portSetByUser = false;
-        service.resetState();
     }
 
     public Destination withSocketAddress(SocketAddress socketAddress) {
@@ -186,101 +176,4 @@ public Destination withInetAddress(InetAddress inetAddress) {
         return this;
     }
 
-    /**
-     * Context information required for service maps.
-     */
-    public static class Service implements Recyclable {
-        /**
-         * Used for detecting unique destinations from each service.
-         * For HTTP, this is the address, with the port (even when it's the default port), without any scheme.
-         * For other types of connections, it's just the {@code span.subtype} (kafka, elasticsearch etc.).
-         * For messaging, we additionally add the queue name (eg jms/myQueue).
-         */
-        private final StringBuilder resource = new StringBuilder();
-
-        private boolean resourceSetByUser;
-
-        /**
-         * Used for detecting “sameness” of services and then the display name of a service in the Service Map.
-         * In other words, the {@link Service#resource} is used to query data for ALL destinations. However,
-         * some `resources` may be nodes of the same cluster, in which case we also want to be aware.
-         * Eventually, we may decide to actively fetch a cluster name or similar and we could use that to detect "sameness".
-         * For now, for HTTP we use scheme, host, and non-default port. For anything else, we use {@code span.subtype}
-         * (for example- postgresql, elasticsearch).
-         *
-         * @deprecated will be removed
-         */
-        private final StringBuilder name = new StringBuilder();
-
-        /**
-         * For displaying icons or similar. Currently, this should be equal to the {@code span.type}.
-         *
-         * @deprecated will be removed
-         */
-        @Nullable
-        private String type;
-
-        public Service withUserResource(@Nullable String resource) {
-            if (resource == null || resource.isEmpty()) {
-                this.resource.setLength(0);
-            } else {
-                setResourceValue(resource);
-            }
-            resourceSetByUser = true;
-            return this;
-        }
-
-        public Service withResource(String resource) {
-            if (!resourceSetByUser) {
-                setResourceValue(resource);
-            }
-            return this;
-        }
-
-        private void setResourceValue(String newValue) {
-            resource.setLength(0);
-            resource.append(newValue);
-        }
-
-        public boolean isResourceSetByUser() {
-            return resourceSetByUser;
-        }
-
-        public StringBuilder getResource() {
-            return resource;
-        }
-
-        @Deprecated
-        public Service withName(String name) {
-            return this;
-        }
-
-        @Deprecated
-        public StringBuilder getName() {
-            return name;
-        }
-
-        @Deprecated
-        public Service withType(@Nullable String type) {
-            return this;
-        }
-
-        @Nullable
-        @Deprecated
-        public String getType() {
-            return type;
-        }
-
-        public boolean hasContent() {
-            return resource.length() > 0;
-        }
-
-        @Override
-        public void resetState() {
-            resource.setLength(0);
-            resourceSetByUser = false;
-            name.setLength(0);
-            type = null;
-        }
-    }
 }