make alarm callbacks API compatible to v1.0 again. fixes #1221

Graylog2 · Jun 5, 2015 · 343e7ef · 343e7ef
1 parent 35de828
commit 343e7ef
Show file tree

Hide file tree

Showing 7 changed files with 51 additions and 3 deletions.
diff --git a/graylog2-plugin-interfaces/src/main/java/org/graylog2/plugin/alarms/AlertCondition.java b/graylog2-plugin-interfaces/src/main/java/org/graylog2/plugin/alarms/AlertCondition.java
@@ -22,6 +22,8 @@
  */
 package org.graylog2.plugin.alarms;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import org.graylog2.plugin.Message;
 import org.graylog2.plugin.MessageSummary;
 import org.graylog2.plugin.streams.Stream;
 import org.joda.time.DateTime;
@@ -35,6 +37,15 @@
 public interface AlertCondition {
     String getDescription();
 
+    /**
+      * The limited list of internal message objects that matched the alert.
+      * @see org.graylog2.plugin.alarms.AlertCondition.CheckResult#getMatchingMessages()
+      * @return list of Message objects
+      */
+    @Deprecated
+    @JsonIgnore
+    List<Message> getSearchHits();
+
     String getId();
 
     DateTime getCreatedAt();

diff --git a/graylog2-server/src/main/java/org/graylog2/alerts/AbstractAlertCondition.java b/graylog2-server/src/main/java/org/graylog2/alerts/AbstractAlertCondition.java
@@ -19,6 +19,7 @@
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.Lists;
+import org.graylog2.plugin.Message;
 import org.graylog2.plugin.MessageSummary;
 import org.graylog2.plugin.Tools;
 import org.graylog2.plugin.alarms.AlertCondition;

diff --git a/graylog2-server/src/main/java/org/graylog2/alerts/types/DummyAlertCondition.java b/graylog2-server/src/main/java/org/graylog2/alerts/types/DummyAlertCondition.java
@@ -17,10 +17,12 @@
 package org.graylog2.alerts.types;
 
 import org.graylog2.alerts.AbstractAlertCondition;
+import org.graylog2.plugin.Message;
 import org.graylog2.plugin.Tools;
 import org.graylog2.plugin.streams.Stream;
 import org.joda.time.DateTime;
 
+import java.util.List;
 import java.util.Map;
 
 /**
@@ -42,4 +44,10 @@ public String getDescription() {
     public CheckResult runCheck() {
         return new CheckResult(true, this, this.description, Tools.iso8601(), null);
     }
+
+    @Override
+    public List<Message> getSearchHits() {
+        return null;
+    }
+
 }
diff --git a/graylog2-server/src/main/java/org/graylog2/alerts/types/FieldContentValueAlertCondition.java b/graylog2-server/src/main/java/org/graylog2/alerts/types/FieldContentValueAlertCondition.java
@@ -49,6 +49,7 @@ public class FieldContentValueAlertCondition extends AbstractAlertCondition {
     private final Configuration configuration;
     private final String field;
     private final String value;
+    private List<Message> searchHits = Lists.newArrayList();
 
     public interface Factory {
         FieldContentValueAlertCondition createAlertCondition(Stream stream, String id, DateTime createdAt, @Assisted("userid") String creatorUserId, Map<String, Object> parameters);
@@ -91,6 +92,7 @@ protected CheckResult runCheck() {
                 summaries = Lists.newArrayListWithCapacity(result.getResults().size());
                 for (ResultMessage resultMessage : result.getResults()) {
                     final Message msg = new Message(resultMessage.getMessage());
+                    searchHits.add(msg);
                     summaries.add(new MessageSummary(resultMessage.getIndex(), msg));
                 }
             } else {
@@ -124,4 +126,9 @@ protected CheckResult runCheck() {
     public String getDescription() {
         return "field: " + field + ", value: " + value;
     }
+
+    @Override
+    public List<Message> getSearchHits() {
+        return searchHits;
+    }
 }
diff --git a/graylog2-server/src/main/java/org/graylog2/alerts/types/FieldValueAlertCondition.java b/graylog2-server/src/main/java/org/graylog2/alerts/types/FieldValueAlertCondition.java
@@ -62,6 +62,7 @@ public interface Factory {
     private final String field;
     private final DecimalFormat decimalFormat;
     private final Searches searches;
+    private List<Message> searchHits = Lists.newArrayList();
 
     @AssistedInject
     public FieldValueAlertCondition(Searches searches, @Assisted Stream stream, @Nullable @Assisted String id, @Assisted DateTime createdAt, @Assisted("userid") String creatorUserId, @Assisted Map<String, Object> parameters) {
@@ -87,6 +88,7 @@ public String getDescription() {
                 + ", grace: " + grace;
     }
 
+
     @Override
     protected CheckResult runCheck() {
         try {
@@ -148,10 +150,11 @@ protected CheckResult runCheck() {
 
                 final List<MessageSummary> summaries;
                 if (getBacklog() > 0) {
-                    final List<ResultMessage> searchHits = fieldStatsResult.getSearchHits();
-                    summaries = Lists.newArrayListWithCapacity(searchHits.size());
-                    for (ResultMessage resultMessage : searchHits) {
+                    final List<ResultMessage> searchResult = fieldStatsResult.getSearchHits();
+                    summaries = Lists.newArrayListWithCapacity(searchResult.size());
+                    for (ResultMessage resultMessage : searchResult) {
                         final Message msg = new Message(resultMessage.getMessage());
+                        this.searchHits.add(msg);
                         summaries.add(new MessageSummary(resultMessage.getIndex(), msg));
                     }
                 } else {
@@ -175,4 +178,9 @@ protected CheckResult runCheck() {
             return new NegativeCheckResult(this);
         }
     }
+
+    @Override
+    public List<Message> getSearchHits() {
+        return searchHits;
+    }
 }
diff --git a/graylog2-server/src/main/java/org/graylog2/alerts/types/MessageCountAlertCondition.java b/graylog2-server/src/main/java/org/graylog2/alerts/types/MessageCountAlertCondition.java
@@ -124,4 +124,10 @@ protected CheckResult runCheck() {
             return null;
         }
     }
+
+    @Override
+    public List<Message> getSearchHits() {
+        return this.searchHits;
+    }
+
 }
diff --git a/graylog2-server/src/test/java/org/graylog2/alerts/AbstractAlertConditionTest.java b/graylog2-server/src/test/java/org/graylog2/alerts/AbstractAlertConditionTest.java
@@ -16,12 +16,14 @@
  */
 package org.graylog2.alerts;
 
+import org.graylog2.plugin.Message;
 import org.graylog2.plugin.Tools;
 import org.graylog2.plugin.alarms.AlertCondition;
 import org.junit.Before;
 import org.junit.Ignore;
 import org.junit.Test;
 
+import java.util.List;
 import java.util.Map;
 
 import static org.junit.Assert.assertFalse;
@@ -73,6 +75,11 @@ public String getDescription() {
             protected AlertCondition.CheckResult runCheck() {
                 return null;
             }
+
+            @Override
+            public List<Message> getSearchHits() {
+                return null;
+            }
         };
     }
 }