Added support for setting a user's domain (#1756)

Author: tobiasstadler

CHANGELOG.asciidoc

@@ -62,6 +62,7 @@ Even when matching on the main class name or on system properties,
 * Cassandra instrumentation - {pull}1712[#1712]
 * Log correlation supports JBoss Logging - {pull}1737[#1737]
 * Update Byte-buddy to `1.11.0` - {pull}1769[#1769]
+* Support for user.domain {pull}1756[#1756]
 
 [float]
 ===== Bug fixes

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

@@ -116,6 +116,12 @@ public Transaction setUser(String id, String email, String username) {
         return this;
     }
 
+    @Override
+    public Transaction setUser(String id, String email, String username, String domain) {
+        // noop
+        return this;
+    }
+
     @Override
     public Transaction setResult(String result) {
         // noop

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

@@ -181,6 +181,23 @@ public interface Transaction extends Span {
      */
     Transaction setUser(String id, String email, String username);
 
+    /**
+     * Call this to enrich collected performance data and errors with information about the user/client.
+     * <p>
+     * This method can be called at any point during the request/response life cycle (i.e. while a transaction is active).
+     * The given context will be added to the active transaction.
+     * </p>
+     * <p>
+     * If an error is captured, the context from the active transaction is used as context for the captured error.
+     * </p>
+     *
+     * @param id       The user's id or {@code null}, if not applicable.
+     * @param email    The user's email address or {@code null}, if not applicable.
+     * @param username The user's name or {@code null}, if not applicable.
+     * @param domain   The user's domain or {@code null}, if not applicable.
+     */
+    Transaction setUser(String id, String email, String username, String domain);
+
     /**
      * A string describing the result of the transaction.
      * This is typically the HTTP status code, or e.g. "success" for a background task

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

@@ -134,6 +134,12 @@ public Transaction setUser(String id, String email, String username) {
         return this;
     }
 
+    @Override
+    public Transaction setUser(String id, String email, String username, String domain) {
+        // co.elastic.apm.agent.pluginapi.TransactionInstrumentation$SetUserInstrumentation.setUser
+        return this;
+    }
+
     @Override
     public Transaction setResult(String result) {
         // co.elastic.apm.agent.pluginapi.TransactionInstrumentation.SetResultInstrumentation

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

@@ -11,9 +11,9 @@
  * 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
@@ -37,6 +37,12 @@
  */
 public class User implements Recyclable {
 
+    /**
+     * Domain of the logged in user
+     */
+    @Nullable
+    private String domain;
+
     /**
      * Identifier of the logged in user, e.g. the primary key of the user
      */
@@ -53,6 +59,23 @@ public class User implements Recyclable {
     @Nullable
     private String username;
 
+
+    /**
+     * Domain of the logged in user
+     */
+    @Nullable
+    public String getDomain() {
+        return domain;
+    }
+
+    /**
+     * Domain of the logged in user
+     */
+    public User withDomain(@Nullable String domain) {
+        this.domain = domain;
+        return this;
+    }
+
     /**
      * Identifier of the logged in user, e.g. the primary key of the user
      */
@@ -103,18 +126,20 @@ public User withUsername(@Nullable String username) {
 
     @Override
     public void resetState() {
+        domain = null;
         id = null;
         email = null;
         username = null;
     }
 
     public void copyFrom(User other) {
+        this.domain = other.domain;
         this.email = other.email;
         this.id = other.id;
         this.username = other.username;
     }
 
     public boolean hasContent() {
-        return id != null || email != null || username != null;
+        return domain != null || id != null || email != null || username != null;
     }
 }

apm-agent-core/src/main/java/co/elastic/apm/agent/impl/transaction/Transaction.java

@@ -207,11 +207,11 @@ public Transaction withResult(@Nullable String result) {
         return this;
     }
 
-    public void setUser(String id, String email, String username) {
+    public void setUser(String id, String email, String username, String domain) {
         if (!isSampled()) {
             return;
         }
-        getContext().getUser().withId(id).withEmail(email).withUsername(username);
+        getContext().getUser().withDomain(domain).withId(id).withEmail(email).withUsername(username);
     }
 
     @Override

apm-agent-core/src/main/java/co/elastic/apm/agent/report/serialize/DslJsonSerializer.java

@@ -1231,6 +1231,7 @@ private void serializePotentiallyMultiValuedEntry(String key, @Nullable Object v
     private void serializeUser(final User user) {
         writeFieldName("user");
         jw.writeByte(OBJECT_START);
+        writeField("domain", user.getDomain());
         writeField("id", user.getId());
         writeField("email", user.getEmail());
         writeLastField("username", user.getUsername());

apm-agent-core/src/test/java/co/elastic/apm/agent/impl/ElasticApmTracerTest.java

@@ -343,7 +343,7 @@ void testSamplingNone() throws IOException {
         Transaction transaction = startTestRootTransaction().withType("request");
 
         try (Scope scope = transaction.activateInScope()) {
-            transaction.setUser("1", "[email protected]", "jondoe");
+            transaction.setUser("1", "[email protected]", "jondoe", "domain");
             Span span = tracerImpl.getActive().createSpan();
             try (Scope spanScope = span.activateInScope()) {
                 span.end();

apm-agent-plugins/apm-api-plugin/src/main/java/co/elastic/apm/agent/pluginapi/TransactionInstrumentation.java

@@ -66,9 +66,9 @@ public SetUserInstrumentation() {
 
         @Advice.OnMethodEnter(suppress = Throwable.class, inline = false)
         public static void setUser(@Advice.FieldValue(value = "span", typing = Assigner.Typing.DYNAMIC) Object transaction,
-                                   @Advice.Argument(0) String id, @Advice.Argument(1) String email, @Advice.Argument(2) String username) {
+                                   @Advice.Argument(0) String id, @Advice.Argument(1) String email, @Advice.Argument(2) String username, @Advice.Argument(value = 3, optional = true) String domain) {
             if (transaction instanceof Transaction) {
-                ((Transaction) transaction).setUser(id, email, username);
+                ((Transaction) transaction).setUser(id, email, username, domain);
             }
         }
     }

apm-agent-plugins/apm-api-plugin/src/test/java/co/elastic/apm/agent/pluginapi/TransactionInstrumentationTest.java

@@ -89,8 +89,19 @@ void testAddOrSetLabel() {
 
     @Test
     void testSetUser() {
+        transaction.setUser("foo", "bar", "baz", "abc");
+        endTransaction();
+        assertThat(reporter.getFirstTransaction().getContext().getUser().getDomain()).isEqualTo("abc");
+        assertThat(reporter.getFirstTransaction().getContext().getUser().getId()).isEqualTo("foo");
+        assertThat(reporter.getFirstTransaction().getContext().getUser().getEmail()).isEqualTo("bar");
+        assertThat(reporter.getFirstTransaction().getContext().getUser().getUsername()).isEqualTo("baz");
+    }
+
+    @Test
+    void testSetUserWithoutDomain() {
         transaction.setUser("foo", "bar", "baz");
         endTransaction();
+        assertThat(reporter.getFirstTransaction().getContext().getUser().getDomain()).isNull();
         assertThat(reporter.getFirstTransaction().getContext().getUser().getId()).isEqualTo("foo");
         assertThat(reporter.getFirstTransaction().getContext().getUser().getEmail()).isEqualTo("bar");
         assertThat(reporter.getFirstTransaction().getContext().getUser().getUsername()).isEqualTo("baz");
@@ -137,12 +148,13 @@ void testChaining() {
             .setLabel("stringKey", randomString)
             .setLabel("numberKey", randomInt)
             .setLabel("booleanKey", randomBoolean)
-            .setUser("foo", "bar", "baz")
+            .setUser("foo", "bar", "baz", "abc")
             .setResult("foo");
         endTransaction();
         assertThat(reporter.getFirstTransaction().getNameAsString()).isEqualTo("foo");
         assertThat(reporter.getFirstTransaction().getType()).isEqualTo("foo");
         assertThat(reporter.getFirstTransaction().getContext().getLabel("foo")).isEqualTo("bar");
+        assertThat(reporter.getFirstTransaction().getContext().getUser().getDomain()).isEqualTo("abc");
         assertThat(reporter.getFirstTransaction().getContext().getUser().getId()).isEqualTo("foo");
         assertThat(reporter.getFirstTransaction().getContext().getUser().getEmail()).isEqualTo("bar");
         assertThat(reporter.getFirstTransaction().getContext().getUser().getUsername()).isEqualTo("baz");