org.graylog2.plugin.alarms.AlertCondition Maven / Gradle / Ivy
/**
* This file is part of Graylog.
*
* Graylog is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Graylog is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Graylog. If not, see .
*/
package org.graylog2.plugin.alarms;
import com.fasterxml.jackson.annotation.JsonIgnore;
import org.graylog2.plugin.DescriptorWithHumanName;
import org.graylog2.plugin.MessageSummary;
import org.graylog2.plugin.configuration.ConfigurationRequest;
import org.graylog2.plugin.streams.Stream;
import org.joda.time.DateTime;
import javax.annotation.Nullable;
import java.util.List;
import java.util.Map;
public interface AlertCondition {
@JsonIgnore
String getDescription();
String getId();
DateTime getCreatedAt();
String getCreatorUserId();
Stream getStream();
Map getParameters();
@JsonIgnore
Integer getBacklog();
@JsonIgnore
int getGrace();
String getType();
String getTitle();
boolean shouldRepeatNotifications();
AlertCondition.CheckResult runCheck();
interface CheckResult {
boolean isTriggered();
String getResultDescription();
AlertCondition getTriggeredCondition();
DateTime getTriggeredAt();
/**
* The limited list of messages that matched the alert in the corresponding stream.
*
* @return list of message summaries
*/
List getMatchingMessages();
}
interface Factory {
AlertCondition create(Stream stream,
String id,
DateTime createdAt,
String creatorUserId,
Map parameters,
@Nullable String title);
Config config();
Descriptor descriptor();
}
abstract class Descriptor extends DescriptorWithHumanName {
public Descriptor(String name, String linkToDocs, String humanName) {
super(name, false, linkToDocs, humanName);
}
}
interface Config {
ConfigurationRequest getRequestedConfiguration();
}
}