Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.graylog2.contentpacks.facades.StreamFacade Maven / Gradle / Ivy
/*
* Copyright (C) 2020 Graylog, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* .
*/
package org.graylog2.contentpacks.facades;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.graph.Graph;
import com.google.common.graph.GraphBuilder;
import com.google.common.graph.ImmutableGraph;
import com.google.common.graph.MutableGraph;
import org.bson.types.ObjectId;
import org.graylog.events.legacy.V20190722150700_LegacyAlertConditionMigration;
import org.graylog2.alarmcallbacks.AlarmCallbackConfiguration;
import org.graylog2.alarmcallbacks.AlarmCallbackConfigurationService;
import org.graylog2.alerts.AlertService;
import org.graylog2.contentpacks.EntityDescriptorIds;
import org.graylog2.contentpacks.exceptions.ContentPackException;
import org.graylog2.contentpacks.model.ModelId;
import org.graylog2.contentpacks.model.ModelType;
import org.graylog2.contentpacks.model.ModelTypes;
import org.graylog2.contentpacks.model.entities.Entity;
import org.graylog2.contentpacks.model.entities.EntityDescriptor;
import org.graylog2.contentpacks.model.entities.EntityExcerpt;
import org.graylog2.contentpacks.model.entities.EntityV1;
import org.graylog2.contentpacks.model.entities.NativeEntity;
import org.graylog2.contentpacks.model.entities.NativeEntityDescriptor;
import org.graylog2.contentpacks.model.entities.StreamAlarmCallbackEntity;
import org.graylog2.contentpacks.model.entities.StreamAlertConditionEntity;
import org.graylog2.contentpacks.model.entities.StreamEntity;
import org.graylog2.contentpacks.model.entities.StreamRuleEntity;
import org.graylog2.contentpacks.model.entities.references.ReferenceMapUtils;
import org.graylog2.contentpacks.model.entities.references.ValueReference;
import org.graylog2.database.NotFoundException;
import org.graylog2.indexer.indexset.IndexSetService;
import org.graylog2.plugin.alarms.AlertCondition;
import org.graylog2.plugin.configuration.ConfigurationException;
import org.graylog2.plugin.database.ValidationException;
import org.graylog2.plugin.database.users.User;
import org.graylog2.plugin.streams.Output;
import org.graylog2.plugin.streams.Stream;
import org.graylog2.plugin.streams.StreamRule;
import org.graylog2.plugin.streams.StreamRuleType;
import org.graylog2.rest.models.alarmcallbacks.requests.CreateAlarmCallbackRequest;
import org.graylog2.rest.models.streams.alerts.requests.CreateConditionRequest;
import org.graylog2.rest.resources.streams.requests.CreateStreamRequest;
import org.graylog2.rest.resources.streams.rules.requests.CreateStreamRuleRequest;
import org.graylog2.shared.users.UserService;
import org.graylog2.streams.StreamRuleService;
import org.graylog2.streams.StreamService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.inject.Inject;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;
import static com.google.common.base.Strings.nullToEmpty;
public class StreamFacade implements EntityFacade {
private static final Logger LOG = LoggerFactory.getLogger(StreamFacade.class);
private static final String DUMMY_STREAM_ID = "ffffffffffffffffffffffff";
public static final ModelType TYPE_V1 = ModelTypes.STREAM_V1;
private final ObjectMapper objectMapper;
private final StreamService streamService;
private final StreamRuleService streamRuleService;
private final AlertService streamAlertService;
private final AlarmCallbackConfigurationService alarmCallbackConfigurationService;
private final V20190722150700_LegacyAlertConditionMigration legacyAlertsMigration;
private final IndexSetService indexSetService;
private final UserService userService;
@Inject
public StreamFacade(ObjectMapper objectMapper,
StreamService streamService,
StreamRuleService streamRuleService,
AlertService streamAlertService,
AlarmCallbackConfigurationService alarmCallbackConfigurationService,
V20190722150700_LegacyAlertConditionMigration legacyAlertsMigration,
IndexSetService indexSetService, UserService userService) {
this.objectMapper = objectMapper;
this.streamService = streamService;
this.streamRuleService = streamRuleService;
this.streamAlertService = streamAlertService;
this.alarmCallbackConfigurationService = alarmCallbackConfigurationService;
this.legacyAlertsMigration = legacyAlertsMigration;
this.indexSetService = indexSetService;
this.userService = userService;
}
@VisibleForTesting
Entity exportNativeEntity(Stream stream, EntityDescriptorIds entityDescriptorIds) {
final List streamRules = stream.getStreamRules().stream()
.map(this::encodeStreamRule)
.collect(Collectors.toList());
final Set outputIds = stream.getOutputs().stream()
.map(output -> entityDescriptorIds.getOrThrow(output.getId(), ModelTypes.OUTPUT_V1))
.map(ValueReference::of)
.collect(Collectors.toSet());
final StreamEntity streamEntity = StreamEntity.create(
ValueReference.of(stream.getTitle()),
ValueReference.of(stream.getDescription()),
ValueReference.of(stream.getDisabled()),
ValueReference.of(stream.getMatchingType()),
streamRules,
Collections.emptyList(), // Kept for backwards compatibility
Collections.emptyList(), // Kept for backwards compatibility
outputIds,
ValueReference.of(stream.isDefaultStream()),
ValueReference.of(stream.getRemoveMatchesFromDefaultStream()));
final JsonNode data = objectMapper.convertValue(streamEntity, JsonNode.class);
return EntityV1.builder()
.id(ModelId.of(entityDescriptorIds.getOrThrow(stream.getId(), ModelTypes.STREAM_V1)))
.type(ModelTypes.STREAM_V1)
.data(data)
.build();
}
private StreamRuleEntity encodeStreamRule(StreamRule streamRule) {
return StreamRuleEntity.create(
ValueReference.of(streamRule.getType()),
ValueReference.of(streamRule.getField()),
ValueReference.of(nullToEmpty(streamRule.getValue())), // Rule value can be null!
ValueReference.of(streamRule.getInverted()),
ValueReference.of(nullToEmpty(streamRule.getDescription()))); // Rule description can be null!
}
@Override
public NativeEntity createNativeEntity(Entity entity,
Map parameters,
Map nativeEntities,
String username) {
if (entity instanceof EntityV1) {
final User user = Optional.ofNullable(userService.load(username)).orElseThrow(() -> new IllegalStateException("Cannot load user <" + username + "> from db"));
return decode((EntityV1) entity, parameters, nativeEntities, user);
} else {
throw new IllegalArgumentException("Unsupported entity version: " + entity.getClass());
}
}
private NativeEntity decode(EntityV1 entity,
Map parameters,
Map nativeEntities,
User user) {
final StreamEntity streamEntity = objectMapper.convertValue(entity.data(), StreamEntity.class);
final CreateStreamRequest createStreamRequest = CreateStreamRequest.create(
streamEntity.title().asString(parameters),
streamEntity.description().asString(parameters),
null, // ignored
null,
streamEntity.matchingType().asString(parameters),
streamEntity.removeMatches().asBoolean(parameters),
indexSetService.getDefault().id());
final Stream stream = streamService.create(createStreamRequest, user.getName());
final List streamRules = streamEntity.streamRules().stream()
.map(streamRuleEntity -> createStreamRuleRequest(streamRuleEntity, parameters))
.map(request -> streamRuleService.create(DUMMY_STREAM_ID, request))
.collect(Collectors.toList());
// TODO: The creation of legacy alert conditions should be avoided and a new event definition should be created instead
final List alertConditions = streamEntity.alertConditions().stream()
.map(alertCondition -> createStreamAlertConditionRequest(alertCondition, parameters))
.map(request -> {
try {
return streamAlertService.fromRequest(request, stream, user.getName());
} catch (ConfigurationException e) {
throw new ContentPackException("Couldn't create entity " + entity.toEntityDescriptor(), e);
}
})
.collect(Collectors.toList());
// TODO: The creation of legacy alarm callback should be avoided and a new event notification should be created instead
final List alarmCallbacks = streamEntity.alarmCallbacks().stream()
.map(alarmCallback -> createStreamAlarmCallbackRequest(alarmCallback, parameters))
.map(request -> alarmCallbackConfigurationService.create(stream.getId(), request, user.getName()))
.collect(Collectors.toList());
final String savedStreamId;
try {
savedStreamId = streamService.saveWithRulesAndOwnership(stream, streamRules, user);
for (final AlertCondition alertCondition : alertConditions) {
streamService.addAlertCondition(stream, alertCondition);
}
for (final AlarmCallbackConfiguration alarmCallback : alarmCallbacks) {
alarmCallbackConfigurationService.save(alarmCallback);
}
} catch (ValidationException e) {
throw new ContentPackException("Couldn't create entity " + entity.toEntityDescriptor(), e);
}
final Set outputIds = streamEntity.outputs().stream()
.map(valueReference -> valueReference.asString(parameters))
.map(ModelId::of)
.map(modelId -> EntityDescriptor.create(modelId, ModelTypes.OUTPUT_V1))
.map(descriptor -> findOutput(descriptor, nativeEntities))
.map(Output::getId)
.map(ObjectId::new)
.collect(Collectors.toSet());
streamService.addOutputs(new ObjectId(savedStreamId), outputIds);
if (!alertConditions.isEmpty() || !alarmCallbacks.isEmpty()) {
// Migrated newly created legacy alert conditions and alarm callbacks to the new events system
// TODO: Remove migration call once we updated the above code to directly create event definitions and notifications
try {
legacyAlertsMigration.upgrade();
} catch (Exception e) {
LOG.error("Couldn't run migration for newly created legacy alert conditions and/or alarm callbacks", e);
}
}
return NativeEntity.create(entity.id(), savedStreamId, TYPE_V1, stream.getTitle(), stream);
}
private CreateConditionRequest createStreamAlertConditionRequest(StreamAlertConditionEntity alertCondition,
Map parameters) {
return CreateConditionRequest.builder()
.setType(alertCondition.type())
.setTitle(alertCondition.title().asString(parameters))
.setParameters(ReferenceMapUtils.toValueMap(alertCondition.parameters(), parameters))
.build();
}
private CreateAlarmCallbackRequest createStreamAlarmCallbackRequest(StreamAlarmCallbackEntity alarmCallback,
Map parameters) {
return CreateAlarmCallbackRequest.create(
alarmCallback.type(),
alarmCallback.title().asString(parameters),
ReferenceMapUtils.toValueMap(alarmCallback.configuration(), parameters));
}
private CreateStreamRuleRequest createStreamRuleRequest(StreamRuleEntity streamRuleEntity, Map parameters) {
return CreateStreamRuleRequest.create(
streamRuleEntity.type().asEnum(parameters, StreamRuleType.class).getValue(),
streamRuleEntity.value().asString(parameters),
streamRuleEntity.field().asString(parameters),
streamRuleEntity.inverted().asBoolean(parameters),
streamRuleEntity.description().asString(parameters));
}
private Output findOutput(EntityDescriptor outputDescriptor, Map nativeEntities) {
final Object output = nativeEntities.get(outputDescriptor);
if (output == null) {
throw new ContentPackException("Missing referenced output: " + outputDescriptor);
} else if (output instanceof Output) {
return (Output) output;
} else {
final String msg = "Invalid entity type for referenced output " + outputDescriptor + ": " + output.getClass();
throw new ContentPackException(msg);
}
}
@Override
public Optional> findExisting(Entity entity, Map parameters) {
if (entity instanceof EntityV1) {
return findExisting((EntityV1) entity, parameters);
} else {
throw new IllegalArgumentException("Unsupported entity version: " + entity.getClass());
}
}
private Optional> findExisting(EntityV1 entity, Map parameters) {
final String streamId = entity.id().id();
// Always use the existing default stream
if (Stream.DEFAULT_STREAM_ID.equals(streamId)) {
try {
final Stream stream = streamService.load(Stream.DEFAULT_STREAM_ID);
return Optional.of(NativeEntity.create(entity.id(), Stream.DEFAULT_STREAM_ID, ModelTypes.STREAM_V1, stream.getTitle(), stream));
} catch (NotFoundException e) {
throw new ContentPackException("Default stream <" + streamId + "> does not exist!", e);
}
} else {
return Optional.empty();
}
}
@Override
public Optional> loadNativeEntity(NativeEntityDescriptor nativeEntityDescriptor) {
try {
final Stream stream = streamService.load(nativeEntityDescriptor.id().id());
return Optional.of(NativeEntity.create(nativeEntityDescriptor, stream));
} catch (NotFoundException e) {
return Optional.empty();
}
}
@Override
public void delete(Stream nativeEntity) {
if (nativeEntity.isDefaultStream()) {
LOG.debug("The default stream should not be deleted");
return;
}
try {
streamService.destroy(nativeEntity);
} catch (NotFoundException ignore) {
}
}
@Override
public EntityExcerpt createExcerpt(Stream stream) {
return EntityExcerpt.builder()
.id(ModelId.of(stream.getId()))
.type(ModelTypes.STREAM_V1)
.title(stream.getTitle())
.build();
}
@Override
public Set listEntityExcerpts() {
return streamService.loadAll().stream()
.map(this::createExcerpt)
.collect(Collectors.toSet());
}
@Override
public Optional exportEntity(EntityDescriptor entityDescriptor, EntityDescriptorIds entityDescriptorIds) {
final ModelId modelId = entityDescriptor.id();
try {
final Stream stream = streamService.load(modelId.id());
return Optional.of(exportNativeEntity(stream, entityDescriptorIds));
} catch (NotFoundException e) {
LOG.debug("Couldn't find stream {}", entityDescriptor, e);
return Optional.empty();
}
}
@Override
public Graph resolveNativeEntity(EntityDescriptor entityDescriptor) {
final MutableGraph mutableGraph = GraphBuilder.directed().build();
mutableGraph.addNode(entityDescriptor);
final ModelId modelId = entityDescriptor.id();
try {
final Stream stream = streamService.load(modelId.id());
stream.getOutputs().stream()
.map(Output::getId)
.map(ModelId::of)
.map(id -> EntityDescriptor.create(id, ModelTypes.OUTPUT_V1))
.forEach(output -> mutableGraph.putEdge(entityDescriptor, output));
} catch (NotFoundException e) {
LOG.debug("Couldn't find stream {}", entityDescriptor, e);
}
return ImmutableGraph.copyOf(mutableGraph);
}
@Override
public Graph resolveForInstallation(Entity entity,
Map parameters,
Map entities) {
if (entity instanceof EntityV1) {
return resolveForInstallation((EntityV1) entity, parameters, entities);
} else {
throw new IllegalArgumentException("Unsupported entity version: " + entity.getClass());
}
}
private Graph resolveForInstallation(EntityV1 entity,
Map parameters,
Map entities) {
final MutableGraph mutableGraph = GraphBuilder.directed().build();
mutableGraph.addNode(entity);
final StreamEntity streamEntity = objectMapper.convertValue(entity.data(), StreamEntity.class);
streamEntity.outputs().stream()
.map(valueReference -> valueReference.asString(parameters))
.map(ModelId::of)
.map(modelId -> EntityDescriptor.create(modelId, ModelTypes.OUTPUT_V1))
.map(entities::get)
.filter(Objects::nonNull)
.forEach(outputEntity -> mutableGraph.putEdge(entity, outputEntity));
return ImmutableGraph.copyOf(mutableGraph);
}
}
