com.hubspot.singularity.smtp.SingularityMailer Maven / Gradle / Ivy
package com.hubspot.singularity.smtp;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.lang3.time.DurationFormatUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.common.base.Joiner;
import com.google.common.base.Optional;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableMap.Builder;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.inject.Inject;
import com.google.inject.name.Named;
import com.hubspot.mesos.JavaUtils;
import com.hubspot.singularity.ExtendedTaskState;
import com.hubspot.singularity.RequestType;
import com.hubspot.singularity.SingularityEmailDestination;
import com.hubspot.singularity.SingularityEmailType;
import com.hubspot.singularity.SingularityMainModule;
import com.hubspot.singularity.SingularityRequest;
import com.hubspot.singularity.SingularityTask;
import com.hubspot.singularity.SingularityTaskHistoryUpdate;
import com.hubspot.singularity.SingularityTaskId;
import com.hubspot.singularity.TaskCleanupType;
import com.hubspot.singularity.api.SingularityPauseRequest;
import com.hubspot.singularity.api.SingularityScaleRequest;
import com.hubspot.singularity.config.SMTPConfiguration;
import com.hubspot.singularity.config.SingularityConfiguration;
import com.hubspot.singularity.data.MetadataManager;
import com.hubspot.singularity.data.TaskManager;
import com.hubspot.singularity.sentry.SingularityExceptionNotifier;
import de.neuland.jade4j.Jade4J;
import de.neuland.jade4j.template.JadeTemplate;
import io.dropwizard.lifecycle.Managed;
public class SingularityMailer implements Managed {
private static final Logger LOG = LoggerFactory.getLogger(SingularityMailer.class);
private final SingularitySmtpSender smtpSender;
private final SingularityConfiguration configuration;
private final Optional maybeSmtpConfiguration;
private final Optional mailPreparerExecutorService;
private final SingularityExceptionNotifier exceptionNotifier;
private final TaskManager taskManager;
private final JadeTemplate taskTemplate;
private final JadeTemplate requestInCooldownTemplate;
private final JadeTemplate requestModifiedTemplate;
private final JadeTemplate rateLimitedTemplate;
private final MetadataManager metadataManager;
private final Joiner adminJoiner;
private final MailTemplateHelpers mailTemplateHelpers;
private static final Pattern TASK_STATUS_BY_PATTERN = Pattern.compile("(\\w+) by \\w+");
@Inject
public SingularityMailer(
SingularitySmtpSender smtpSender,
SingularityConfiguration configuration,
TaskManager taskManager,
MetadataManager metadataManager,
SingularityExceptionNotifier exceptionNotifier,
MailTemplateHelpers mailTemplateHelpers,
@Named(SingularityMainModule.TASK_TEMPLATE) JadeTemplate taskTemplate,
@Named(SingularityMainModule.REQUEST_IN_COOLDOWN_TEMPLATE) JadeTemplate requestInCooldownTemplate,
@Named(SingularityMainModule.REQUEST_MODIFIED_TEMPLATE) JadeTemplate requestModifiedTemplate,
@Named(SingularityMainModule.RATE_LIMITED_TEMPLATE) JadeTemplate rateLimitedTemplate) {
this.smtpSender = smtpSender;
this.maybeSmtpConfiguration = configuration.getSmtpConfiguration();
this.configuration = configuration;
this.taskManager = taskManager;
this.metadataManager = metadataManager;
this.exceptionNotifier = exceptionNotifier;
this.adminJoiner = Joiner.on(", ").skipNulls();
this.mailTemplateHelpers = mailTemplateHelpers;
this.requestModifiedTemplate = requestModifiedTemplate;
this.taskTemplate = taskTemplate;
this.requestInCooldownTemplate = requestInCooldownTemplate;
this.rateLimitedTemplate = rateLimitedTemplate;
if (maybeSmtpConfiguration.isPresent()) {
this.mailPreparerExecutorService = Optional.of(JavaUtils.newFixedTimingOutThreadPool(maybeSmtpConfiguration.get().getMailMaxThreads(), TimeUnit.SECONDS.toMillis(1), "SingularityMailPreparer-%d"));
} else {
this.mailPreparerExecutorService = Optional.absent();
}
}
@Override
public void start() throws Exception {
}
@Override
public void stop() throws Exception {
if (mailPreparerExecutorService.isPresent()) {
MoreExecutors.shutdownAndAwaitTermination(mailPreparerExecutorService.get(), 1, TimeUnit.SECONDS);
}
}
private void populateRequestEmailProperties(Map templateProperties, SingularityRequest request) {
templateProperties.put("requestId", request.getId());
templateProperties.put("singularityRequestLink", mailTemplateHelpers.getSingularityRequestLink(request.getId()));
templateProperties.put("requestAlwaysRunning", request.isAlwaysRunning());
templateProperties.put("requestRunOnce", request.getRequestType() == RequestType.RUN_ONCE);
templateProperties.put("requestScheduled", request.isScheduled());
templateProperties.put("requestOneOff", request.isOneOff());
templateProperties.put("taskWillRetry", request.getNumRetriesOnFailure().or(0) > 0);
templateProperties.put("numRetries", request.getNumRetriesOnFailure().or(0));
}
private void populateTaskEmailProperties(Map templateProperties, SingularityTaskId taskId, Collection taskHistory, ExtendedTaskState taskState) {
Optional task = taskManager.getTask(taskId);
Optional directory = taskManager.getDirectory(taskId);
templateProperties.put("singularityTaskLink", mailTemplateHelpers.getSingularityTaskLink(taskId.getId()));
// Grab the tails of log files from remote mesos slaves.
templateProperties.put("logTails", mailTemplateHelpers.getTaskLogs(taskId, task, directory));
templateProperties.put("taskId", taskId.getId());
templateProperties.put("deployId", taskId.getDeployId());
templateProperties.put("taskDirectory", directory.or("directory missing"));
if (task.isPresent()) {
templateProperties.put("slaveHostname", task.get().getOffer().getHostname());
}
boolean needsBeenPrefix = taskState == ExtendedTaskState.TASK_LOST || taskState == ExtendedTaskState.TASK_KILLED;
templateProperties.put("status", String.format("%s%s", needsBeenPrefix ? "has been " : "has ", taskState.getDisplayName()));
templateProperties.put("taskStateLost", taskState == ExtendedTaskState.TASK_LOST);
templateProperties.put("taskStateFailed", taskState == ExtendedTaskState.TASK_FAILED);
templateProperties.put("taskStateFinished", taskState == ExtendedTaskState.TASK_FINISHED);
templateProperties.put("taskStateKilled", taskState == ExtendedTaskState.TASK_KILLED);
templateProperties.put("taskStateRunning", taskState == ExtendedTaskState.TASK_RUNNING);
templateProperties.put("taskUpdates", mailTemplateHelpers.getJadeTaskHistory(taskHistory));
templateProperties.put("taskRan", mailTemplateHelpers.didTaskRun(taskHistory));
}
private static Optional getTaskCleanupTypefromSingularityTaskHistoryUpdate(SingularityTaskHistoryUpdate taskHistoryUpdate) {
if (!taskHistoryUpdate.getStatusMessage().isPresent()) {
return Optional.absent();
}
String taskCleanupTypeMsg = taskHistoryUpdate.getStatusMessage().get();
Matcher matcher = TASK_STATUS_BY_PATTERN.matcher(taskCleanupTypeMsg);
if (matcher.find()) {
taskCleanupTypeMsg = matcher.group(1);
}
try {
return Optional.of(TaskCleanupType.valueOf(taskCleanupTypeMsg.toUpperCase()));
} catch (IllegalArgumentException iae) {
LOG.warn("Couldn't parse TaskCleanupType from update {}", taskHistoryUpdate);
return Optional.absent();
}
}
private Optional getEmailType(ExtendedTaskState taskState, SingularityRequest request, Collection taskHistory) {
final Optional cleaningUpdate = SingularityTaskHistoryUpdate.getUpdate(taskHistory, ExtendedTaskState.TASK_CLEANING);
switch (taskState) {
case TASK_FAILED:
if (cleaningUpdate.isPresent()) {
Optional cleanupType = getTaskCleanupTypefromSingularityTaskHistoryUpdate(cleaningUpdate.get());
if (cleanupType.isPresent() && cleanupType.get() == TaskCleanupType.DECOMISSIONING) {
return Optional.of(SingularityEmailType.TASK_FAILED_DECOMISSIONED);
}
}
return Optional.of(SingularityEmailType.TASK_FAILED);
case TASK_FINISHED:
switch (request.getRequestType()) {
case ON_DEMAND:
return Optional.of(SingularityEmailType.TASK_FINISHED_ON_DEMAND);
case RUN_ONCE:
return Optional.of(SingularityEmailType.TASK_FINISHED_RUN_ONCE);
case SCHEDULED:
return Optional.of(SingularityEmailType.TASK_FINISHED_SCHEDULED);
case SERVICE:
case WORKER:
return Optional.of(SingularityEmailType.TASK_FINISHED_LONG_RUNNING);
}
case TASK_KILLED:
if (cleaningUpdate.isPresent()) {
Optional cleanupType = getTaskCleanupTypefromSingularityTaskHistoryUpdate(cleaningUpdate.get());
if (cleanupType.isPresent()) {
switch (cleanupType.get()) {
case DECOMISSIONING:
return Optional.of(SingularityEmailType.TASK_KILLED_DECOMISSIONED);
case UNHEALTHY_NEW_TASK:
case OVERDUE_NEW_TASK:
return Optional.of(SingularityEmailType.TASK_KILLED_UNHEALTHY);
default:
}
}
}
return Optional.of(SingularityEmailType.TASK_KILLED);
case TASK_LOST:
return Optional.of(SingularityEmailType.TASK_LOST);
default:
return Optional.absent();
}
}
public void sendTaskOverdueMail(final Optional task, final SingularityTaskId taskId, final SingularityRequest request, final long runTime, final long expectedRuntime) {
final Builder templateProperties = ImmutableMap.builder();
templateProperties.put("runTime", DurationFormatUtils.formatDurationHMS(runTime));
templateProperties.put("expectedRunTime", DurationFormatUtils.formatDurationHMS(expectedRuntime));
templateProperties.put("warningThreshold", String.format("%s%%", configuration.getWarnIfScheduledJobIsRunningPastNextRunPct()));
templateProperties.put("status", "is overdue to finish");
prepareTaskMail(task, taskId, request, SingularityEmailType.TASK_SCHEDULED_OVERDUE_TO_FINISH, templateProperties.build(), taskManager.getTaskHistoryUpdates(taskId), ExtendedTaskState.TASK_RUNNING);
}
public void sendTaskCompletedMail(final Optional task, final SingularityTaskId taskId, final SingularityRequest request, final ExtendedTaskState taskState) {
if (!maybeSmtpConfiguration.isPresent()) {
LOG.debug("Not sending task completed mail - no SMTP configuration is present");
return;
}
mailPreparerExecutorService.get().submit(new Runnable() {
@Override
public void run() {
try {
prepareTaskCompletedMail(task, taskId, request, taskState);
} catch (Throwable t) {
LOG.error("While preparing task completed mail for {}", taskId, t);
exceptionNotifier.notify(t, ImmutableMap.of("taskId", taskId.toString()));
}
}
});
}
private void prepareTaskMail(Optional task, SingularityTaskId taskId, SingularityRequest request, SingularityEmailType emailType, Map extraProperties,
Collection taskHistory, ExtendedTaskState taskState) {
final Collection emailDestination = getDestination(request, emailType);
if (emailDestination.isEmpty()) {
LOG.debug("Not configured to send task mail for {}", emailType);
return;
}
final Map templateProperties = Maps.newHashMap();
populateRequestEmailProperties(templateProperties, request);
populateTaskEmailProperties(templateProperties, taskId, taskHistory, taskState);
templateProperties.putAll(extraProperties);
final String subject = mailTemplateHelpers.getSubjectForTaskHistory(taskId, taskState, emailType, taskHistory);
final String adminEmails = adminJoiner.join(maybeSmtpConfiguration.get().getAdmins());
templateProperties.put("adminEmails", adminEmails);
final String body = Jade4J.render(taskTemplate, templateProperties);
final Optional user = task.isPresent() ? task.get().getTaskRequest().getPendingTask().getUser() : Optional. absent();
queueMail(emailDestination, request, emailType, user, subject, body);
}
private void prepareTaskCompletedMail(Optional task, SingularityTaskId taskId, SingularityRequest request, ExtendedTaskState taskState) {
final Collection taskHistory = taskManager.getTaskHistoryUpdates(taskId);
final Optional emailType = getEmailType(taskState, request, taskHistory);
if (!emailType.isPresent()) {
LOG.debug("No configured emailType for {} and {}", request, taskState);
return;
}
prepareTaskMail(task, taskId, request, emailType.get(), Collections. emptyMap(), taskHistory, taskState);
}
private List getDestination(SingularityRequest request, SingularityEmailType type) {
// check for request-level email override
if (request.getEmailConfigurationOverrides().isPresent() && request.getEmailConfigurationOverrides().get().get(type) != null) {
return request.getEmailConfigurationOverrides().get().get(type);
}
List fromMap = maybeSmtpConfiguration.get().getEmailConfiguration().get(type);
if (fromMap == null) {
return Collections.emptyList();
}
return fromMap;
}
public enum RequestMailType {
PAUSED(SingularityEmailType.REQUEST_PAUSED), UNPAUSED(SingularityEmailType.REQUEST_UNPAUSED), REMOVED(SingularityEmailType.REQUEST_REMOVED), SCALED(SingularityEmailType.REQUEST_SCALED);
private final SingularityEmailType emailType;
private RequestMailType(SingularityEmailType emailType) {
this.emailType = emailType;
}
public SingularityEmailType getEmailType() {
return emailType;
}
}
private void sendRequestMail(final SingularityRequest request, final RequestMailType type, final Optional user, final Optional message, final Optional © 2015 - 2025 Weber Informatics LLC | Privacy Policy