Skip to content

Commit

Permalink
Refactor event definition handling for search filter usage
Browse files Browse the repository at this point in the history
  • Loading branch information
@ryan-carroll-graylog
ryan-carroll-graylog committed May 24, 2024
1 parent 03ca119 commit 0633495
Show file tree
Hide file tree
Showing 5 changed files with 140 additions and 72 deletions.
98 changes: 62 additions & 36 deletions graylog2-server/src/main/java/org/graylog/events/processor/DBEventDefinitionService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,13 @@
package org.graylog.events.processor;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import jakarta.inject.Inject;
import jakarta.validation.constraints.NotNull;
import jakarta.ws.rs.BadRequestException;
import org.bson.types.ObjectId;
import org.graylog.events.notifications.EventNotificationConfig;
import org.graylog.events.processor.systemnotification.SystemNotificationEventEntityScope;
import org.graylog.plugins.views.search.searchfilters.db.SearchFiltersReFetcher;
import org.graylog.plugins.views.search.searchfilters.model.UsedSearchFilter;
import org.graylog.security.entities.EntityOwnershipService;
import org.graylog2.bindings.providers.MongoJackObjectMapperProvider;
Expand All @@ -32,6 +33,8 @@
import org.graylog2.database.entities.ScopedDbService;
import org.graylog2.plugin.database.users.User;
import org.graylog2.search.SearchQuery;
import org.graylog2.search.SearchQueryField;
import org.graylog2.search.SearchQueryParser;
import org.joda.time.DateTime;
import org.joda.time.DateTimeZone;
import org.mongojack.DBQuery;
Expand All @@ -42,45 +45,48 @@

import java.util.List;
import java.util.Locale;
import java.util.Optional;
import java.util.function.Predicate;
import java.util.function.Supplier;
import java.util.stream.Collectors;

public class DBEventDefinitionService extends ScopedDbService<EventDefinitionDto> {
private static final Logger LOG = LoggerFactory.getLogger(DBEventDefinitionService.class);

public static final String COLLECTION_NAME = "event_definitions";

public static final ImmutableMap<String, SearchQueryField> SEARCH_FIELD_MAPPING = ImmutableMap.<String, SearchQueryField>builder()
.put("id", SearchQueryField.create("_id", SearchQueryField.Type.OBJECT_ID))
.put("title", SearchQueryField.create(EventDefinitionDto.FIELD_TITLE))
.put("description", SearchQueryField.create(EventDefinitionDto.FIELD_DESCRIPTION))
.build();

private final DBEventProcessorStateService stateService;
private final EntityOwnershipService entityOwnerShipService;
private final SearchFiltersReFetcher searchFiltersRefetcher;
private final SearchQueryParser searchQueryParser;

@Inject
public DBEventDefinitionService(MongoConnection mongoConnection,
MongoJackObjectMapperProvider mapper,
DBEventProcessorStateService stateService,
EntityOwnershipService entityOwnerShipService, EntityScopeService entityScopeService, SearchFiltersReFetcher searchFiltersRefetcher) {
EntityOwnershipService entityOwnerShipService,
EntityScopeService entityScopeService) {
super(mongoConnection, mapper, EventDefinitionDto.class, COLLECTION_NAME, entityScopeService);
this.stateService = stateService;
this.entityOwnerShipService = entityOwnerShipService;
this.searchFiltersRefetcher = searchFiltersRefetcher;
this.searchQueryParser = new SearchQueryParser(EventDefinitionDto.FIELD_TITLE, SEARCH_FIELD_MAPPING);
}

public PaginatedList<EventDefinitionDto> searchPaginated(SearchQuery query, Predicate<EventDefinitionDto> filter,
public PaginatedList<EventDefinitionDto> searchPaginated(String query, Predicate<EventDefinitionDto> filter,
String sortByField, String sortOrder, int page, int perPage) {
final DBQuery.Query dbQuery = query.toDBQuery();
final SearchQuery searchQuery;
try {
searchQuery = searchQueryParser.parse(query);
} catch (IllegalArgumentException e) {
throw new BadRequestException("Invalid argument in search query: " + e.getMessage());
}
final DBQuery.Query dbQuery = searchQuery.toDBQuery();
final DBSort.SortBuilder sortBuilder = getSortBuilder(sortOrder, sortByField);
final PaginatedList<EventDefinitionDto> list = findPaginatedWithQueryFilterAndSort(dbQuery, filter,
return findPaginatedWithQueryFilterAndSort(dbQuery, filter,
sortBuilder, page, perPage);
return new PaginatedList<>(
list.stream()
.map(this::getEventDefinitionWithRefetchedFilters)
.collect(Collectors.toList()),
list.pagination().total(),
page,
perPage
);
}

public EventDefinitionDto saveWithOwnership(EventDefinitionDto eventDefinitionDto, User user) {
Expand All @@ -95,25 +101,7 @@ public EventDefinitionDto save(final EventDefinitionDto entity) {
.toBuilder()
.updatedAt(DateTime.now(DateTimeZone.UTC))
.build();
return getEventDefinitionWithRefetchedFilters(super.save(enrichedWithUpdateDate));
}

@Override
public Optional<EventDefinitionDto> get(String id) {
return super.get(id).map(this::getEventDefinitionWithRefetchedFilters);
}

private EventDefinitionDto getEventDefinitionWithRefetchedFilters(final EventDefinitionDto eventDefinition) {
final EventProcessorConfig config = eventDefinition.config();
if (searchFiltersRefetcher.turnedOn() && config instanceof SearchFilterableConfig) {
final List<UsedSearchFilter> filters = ((SearchFilterableConfig) config).filters();
final EventProcessorConfig updatedConfig = config.updateFilters(searchFiltersRefetcher.reFetch(filters));
if (updatedConfig == null) {
return eventDefinition;
}
return eventDefinition.toBuilder().config(updatedConfig).build();
}
return eventDefinition;
return super.save(enrichedWithUpdateDate);
}

public void updateMatchedAt(String id, DateTime timeStamp) {
Expand Down Expand Up @@ -178,4 +166,42 @@ public List<EventDefinitionDto> getSystemEventDefinitions() {
public List<EventDefinitionDto> getByArrayValue(String arrayField, String field, String value) {
return ImmutableList.copyOf((db.find(DBQuery.elemMatch(arrayField, DBQuery.is(field, value))).iterator()));
}

/**
* Returns the list of event definitions that is using the given search filter ID and filter by query.
*
* @param searchFilterId the search filter ID
* @param query the search query
* @return the event definitions with the given notification ID
*/
public List<EventDefinitionDto> searchBySearchFilterId(String searchFilterId, String query) {
return ImmutableList.copyOf((db.find(searchFilterSearchQuery(searchFilterId, query)).iterator()));
}

public PaginatedList<EventDefinitionDto> searchPaginatedBySearchFilterId(final String searchFilterId,
final int page,
final int perPage,
final String query,
final String sortByField,
final String sortOrder) {
final DBSort.SortBuilder sortBuilder = getSortBuilder(sortOrder, sortByField);
return findPaginatedWithQueryFilterAndSort(searchFilterSearchQuery(searchFilterId, query), null,
sortBuilder, page, perPage);
}

private DBQuery.Query searchFilterSearchQuery(String searchFilterId, String query) {
final SearchQuery searchQuery;
try {
searchQuery = searchQueryParser.parse(query);
} catch (IllegalArgumentException e) {
throw new BadRequestException("Invalid argument in search query: " + e.getMessage());
}

final String field = String.format(Locale.US, "%s.%s.%s",
EventDefinitionDto.FIELD_CONFIG,
SearchFilterableConfig.FIELD_FILTERS,
UsedSearchFilter.ID_FIELD);

return DBQuery.and(DBQuery.in(field, searchFilterId), searchQuery.toDBQuery());
}
}
61 changes: 61 additions & 0 deletions graylog2-server/src/main/java/org/graylog/events/processor/EventDefinitionService.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
package org.graylog.events.processor;

import jakarta.inject.Inject;
import org.graylog.plugins.views.search.searchfilters.db.SearchFiltersReFetcher;
import org.graylog.plugins.views.search.searchfilters.model.UsedSearchFilter;
import org.graylog2.database.PaginatedList;

import java.util.List;
import java.util.Optional;
import java.util.function.Predicate;
import java.util.stream.Collectors;

public class EventDefinitionService {
private final DBEventDefinitionService dbEventDefinitionService;
private final SearchFiltersReFetcher searchFiltersRefetcher;

@Inject
public EventDefinitionService(DBEventDefinitionService dbEventDefinitionService,
SearchFiltersReFetcher searchFiltersRefetcher) {
this.dbEventDefinitionService = dbEventDefinitionService;
this.searchFiltersRefetcher = searchFiltersRefetcher;
}

public PaginatedList<EventDefinitionDto> searchPaginated(String query, Predicate<EventDefinitionDto> filter,
String sortByField, String sortOrder, int page, int perPage) {
final PaginatedList<EventDefinitionDto> list = dbEventDefinitionService.searchPaginated(query, filter, sortByField, sortOrder, page, perPage);
return new PaginatedList<>(
list.stream()
.map(this::getEventDefinitionWithRefetchedFilters)
.collect(Collectors.toList()),
list.pagination().total(),
page,
perPage
);
}

public EventDefinitionDto save(final EventDefinitionDto entity) {
return getEventDefinitionWithRefetchedFilters(dbEventDefinitionService.save(entity));
}

public Optional<EventDefinitionDto> get(String id) {
return dbEventDefinitionService.get(id).map(this::getEventDefinitionWithRefetchedFilters);
}

public boolean isMutable(EventDefinitionDto eventDefinition) {
return dbEventDefinitionService.isMutable(eventDefinition);
}

private EventDefinitionDto getEventDefinitionWithRefetchedFilters(final EventDefinitionDto eventDefinition) {
final EventProcessorConfig config = eventDefinition.config();
if (searchFiltersRefetcher.turnedOn() && config instanceof SearchFilterableConfig) {
final List<UsedSearchFilter> filters = ((SearchFilterableConfig) config).filters();
final EventProcessorConfig updatedConfig = config.updateFilters(searchFiltersRefetcher.reFetch(filters));
if (updatedConfig == null) {
return eventDefinition;
}
return eventDefinition.toBuilder().config(updatedConfig).build();
}
return eventDefinition;
}
}
2 changes: 2 additions & 0 deletions graylog2-server/src/main/java/org/graylog/events/processor/SearchFilterableConfig.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,7 @@
import java.util.List;

public interface SearchFilterableConfig {
String FIELD_FILTERS = "filters";

List<UsedSearchFilter> filters();
}
1 change: 0 additions & 1 deletion ...c/main/java/org/graylog/events/processor/aggregation/AggregationEventProcessorConfig.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ public abstract class AggregationEventProcessorConfig implements EventProcessorC

private static final String FIELD_QUERY = "query";
private static final String FIELD_QUERY_PARAMETERS = "query_parameters";
private static final String FIELD_FILTERS = "filters";
private static final String FIELD_STREAMS = "streams";
private static final String FIELD_GROUP_BY = "group_by";
static final String FIELD_SERIES = "series";
Expand Down
Loading

0 comments on commit 0633495

Please sign in to comment.