Filtering Events Feature Request

.gitignore

@@ -8,3 +8,5 @@ target/*
 nb-configuration.xml
 .idea
 *.iml
+docker-compose.yaml
+/.vscode/

pom.xml

@@ -76,7 +76,6 @@
   </dependencyManagement>
 
   <dependencies>
-
     <dependency>
       <groupId>io.jenkins.plugins</groupId>
       <artifactId>jnr-posix-api</artifactId>
@@ -101,6 +100,12 @@
       <version>3.4.0</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>com.github.stefanbirkner</groupId>
+      <artifactId>system-rules</artifactId>
+      <version>1.19.0</version>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>net.bytebuddy</groupId>
       <artifactId>byte-buddy-agent</artifactId>

src/main/java/org/datadog/jenkins/plugins/datadog/DatadogEvent.java

@@ -83,4 +83,6 @@ public Event.Priority toEventPriority(){
 
     public Map<String, Set<String>> getTags();
 
+    public String getEventName();
+
 }

src/main/java/org/datadog/jenkins/plugins/datadog/DatadogUtilities.java

@@ -1064,4 +1064,19 @@ public static String getCatchErrorResult(BlockStartNode startNode) {
         }
         return null;
     }
+
+    /**
+     * Checks to see if event can be sent to client
+     * @param event - the event to check
+     * @return true if event is can be sent to client
+     */
+    public static boolean canSendEventToClient(DatadogEvent event) {
+        DatadogGlobalConfiguration cfg = getDatadogGlobalDescriptor();
+
+        if (cfg == null) { // sometimes null for tests, so default is to send all events
+            return true;
+        }
+
+        return cfg.getListOfIncludedEvents().contains(event.getEventName());
+    }
 }

src/main/java/org/datadog/jenkins/plugins/datadog/events/AbstractDatadogEvent.java

@@ -41,6 +41,7 @@ public abstract class AbstractDatadogEvent implements DatadogEvent {
     private String aggregationKey;
     private Long date;
     private Map<String, Set<String>> tags;
+    protected String eventName;
 
     @Override
     public String getTitle() {
@@ -123,6 +124,10 @@ public void setTags(Map<String, Set<String>> tags) {
         this.tags = tags;
     }
 
+    public String getEventName() {
+        return this.eventName;
+    }
+
     protected String getLocationDetails(){
         String hostMsg = "Host: unknown";
         String instanceMsg = "Jenkins URL: unknown";

src/main/java/org/datadog/jenkins/plugins/datadog/events/BuildAbortedEventImpl.java

@@ -28,7 +28,7 @@ of this software and associated documentation files (the "Software"), to deal
 import org.datadog.jenkins.plugins.datadog.model.BuildData;
 
 public class BuildAbortedEventImpl extends AbstractDatadogBuildEvent {
-
+    
     public BuildAbortedEventImpl(BuildData buildData) {
         super(buildData);
 
@@ -51,5 +51,6 @@ public BuildAbortedEventImpl(BuildData buildData) {
 
         setPriority(Priority.LOW);
         setAlertType(AlertType.INFO);
+        this.eventName = "BuildAborted";
     }
 }

src/main/java/org/datadog/jenkins/plugins/datadog/events/BuildFinishedEventImpl.java

@@ -60,5 +60,7 @@ public BuildFinishedEventImpl(BuildData buildData) {
             setPriority(Priority.NORMAL);
             setAlertType(AlertType.WARNING);
         }
+
+        this.eventName = "BuildCompleted";
     }
 }

src/main/java/org/datadog/jenkins/plugins/datadog/events/BuildStartedEventImpl.java

@@ -32,7 +32,7 @@ of this software and associated documentation files (the "Software"), to deal
  * the right message for Datadog.
  */
 public class BuildStartedEventImpl extends AbstractDatadogBuildEvent {
-
+    
     public BuildStartedEventImpl(BuildData buildData) {
         super(buildData);
 
@@ -55,5 +55,7 @@ public BuildStartedEventImpl(BuildData buildData) {
 
         setPriority(Priority.LOW);
         setAlertType(AlertType.INFO);
+
+        this.eventName = "BuildStarted";
     }
 }

src/main/java/org/datadog/jenkins/plugins/datadog/events/ComputerLaunchFailedEventImpl.java

@@ -49,5 +49,7 @@ public ComputerLaunchFailedEventImpl(Computer computer, TaskListener listener, M
 
         setPriority(Priority.NORMAL);
         setAlertType(AlertType.ERROR);
+
+        this.eventName = "ComputerLaunchFailure";
     }
 }

src/main/java/org/datadog/jenkins/plugins/datadog/events/ComputerOfflineEventImpl.java

@@ -34,6 +34,8 @@ of this software and associated documentation files (the "Software"), to deal
 
 public class ComputerOfflineEventImpl extends AbstractDatadogSimpleEvent {
 
+    private boolean isTemporarily;
+
     public ComputerOfflineEventImpl(Computer computer, OfflineCause cause, Map<String, Set<String>> tags, boolean isTemporarily) {
         super(tags);
         String nodeName = DatadogUtilities.getNodeName(computer);
@@ -49,5 +51,12 @@ public ComputerOfflineEventImpl(Computer computer, OfflineCause cause, Map<Strin
 
         setPriority(Priority.NORMAL);
         setAlertType(AlertType.WARNING);
+
+        this.isTemporarily = isTemporarily;
+        this.eventName = "Computer" + (isTemporarily ? "Temporarily" : "") + "Offline";
+    }
+
+    public boolean isTemporarily() {
+        return this.isTemporarily;
     }
 }

src/main/java/org/datadog/jenkins/plugins/datadog/events/ComputerOnlineEventImpl.java

@@ -34,6 +34,8 @@ of this software and associated documentation files (the "Software"), to deal
 
 public class ComputerOnlineEventImpl extends AbstractDatadogSimpleEvent {
 
+    private boolean isTemporarily;
+
     public ComputerOnlineEventImpl(Computer computer, TaskListener listener, Map<String, Set<String>> tags, boolean isTemporarily) {
         super(tags);
 
@@ -49,5 +51,12 @@ public ComputerOnlineEventImpl(Computer computer, TaskListener listener, Map<Str
 
         setPriority(Priority.LOW);
         setAlertType(AlertType.SUCCESS);
+
+        this.isTemporarily = isTemporarily;
+        this.eventName = "Computer" + (isTemporarily ? "Temporarily" : "") + "Online";
+    }
+
+    public boolean isTemporarily() {
+        return this.isTemporarily;
     }
 }

src/main/java/org/datadog/jenkins/plugins/datadog/events/ItemCRUDEventImpl.java

@@ -37,6 +37,8 @@ public class ItemCRUDEventImpl extends AbstractDatadogSimpleEvent {
     public final static String UPDATED = "Updated";
     public final static String DELETED = "Deleted";
 
+    private String action;
+
     public ItemCRUDEventImpl(Item item, String action, Map<String, Set<String>> tags) {
         super(tags);
 
@@ -57,5 +59,12 @@ public ItemCRUDEventImpl(Item item, String action, Map<String, Set<String>> tags
 
         setPriority(Priority.NORMAL);
         setAlertType(AlertType.INFO);
+
+        this.action = action;
+        this.eventName = "Item" + this.action;
+    }
+
+    public String getAction() {
+        return this.action;
     }
 }

src/main/java/org/datadog/jenkins/plugins/datadog/events/ItemCopiedEventImpl.java

@@ -50,5 +50,7 @@ public ItemCopiedEventImpl(Item src, Item item, Map<String, Set<String>> tags) {
 
         setPriority(Priority.NORMAL);
         setAlertType(AlertType.INFO);
+
+        this.eventName = "ItemCopied";
     }
 }

src/main/java/org/datadog/jenkins/plugins/datadog/events/ItemLocationChangedEventImpl.java

@@ -49,5 +49,7 @@ public ItemLocationChangedEventImpl(Item item, String oldFullName, String newFul
 
         setPriority(Priority.NORMAL);
         setAlertType(AlertType.INFO);
+
+        this.eventName = "ItemLocationChanged";
     }
 }

src/main/java/org/datadog/jenkins/plugins/datadog/events/SCMCheckoutCompletedEventImpl.java

@@ -53,5 +53,7 @@ public SCMCheckoutCompletedEventImpl(BuildData buildData) {
 
         setPriority(Priority.LOW);
         setAlertType(AlertType.SUCCESS);
+
+        this.eventName = "SCMCheckout";
     }
 }

src/main/java/org/datadog/jenkins/plugins/datadog/events/UserAuthenticationEventImpl.java

@@ -36,6 +36,8 @@ public class UserAuthenticationEventImpl extends AbstractDatadogSimpleEvent {
     public final static String ACCESS_DENIED = "failed to authenticate";
     public final static String LOGOUT = "logout";
 
+    private String action;
+
     public UserAuthenticationEventImpl(String username, String action, Map<String, Set<String>> tags) {
         super(tags);
         // Overriding tags set in parent class
@@ -62,6 +64,19 @@ public UserAuthenticationEventImpl(String username, String action, Map<String, S
             setPriority(Priority.NORMAL);
             setAlertType(AlertType.ERROR);
         }
+
+        this.action = action;
+        this.eventName = "User";
+        if (action.equals(LOGIN)) {
+            this.eventName += "Authenticated";
+        } else if (action.equals(ACCESS_DENIED)) {
+            this.eventName += "FailedToAuthenticate";
+        } else if (action.equals(LOGOUT)) {
+            this.eventName += "LoggedOut";
+        }
     }
 
+    public String getAction() {
+        return this.action;
+    }
 }

src/main/java/org/datadog/jenkins/plugins/datadog/listeners/DatadogBuildListener.java

@@ -182,7 +182,7 @@ public void onStarted(Run run, TaskListener listener) {
 
             // Send an event
             DatadogEvent event = new BuildStartedEventImpl(buildData);
-            client.event(event);
+            if (DatadogUtilities.canSendEventToClient(event)) client.event(event);
 
             // Send a metric
             // item.getInQueueSince() may raise a NPE if a worker node is spinning up to run the job.
@@ -248,7 +248,7 @@ public void onCompleted(Run run, @Nonnull TaskListener listener) {
 
             // Send an event
             DatadogEvent event = new BuildFinishedEventImpl(buildData);
-            client.event(event);
+            if (DatadogUtilities.canSendEventToClient(event)) client.event(event);
 
             // Send a metric
             Map<String, Set<String>> tags = buildData.getTags();
@@ -415,7 +415,7 @@ public void onDeleted(Run run) {
 
             // Send an event
             DatadogEvent event = new BuildAbortedEventImpl(buildData);
-            client.event(event);
+            if (DatadogUtilities.canSendEventToClient(event)) client.event(event);
 
             // Submit counter
             Map<String, Set<String>> tags = buildData.getTags();