Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-18 03:01:05 +01:00
Code Issues Packages Projects Releases Activity

Notifications for health checks (#1664)

Browse Source 
Add list of emergency contacts to global configuration. This user will receive e-mails and notification if some serious system error occurs like repository health check failed.
This commit is contained in:
Florian Scholdei
2021-05-20 08:30:20 +02:00
committed by GitHub
parent cb6806a36f
commit 42745c9e34
24 changed files with 551 additions and 405 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
scm-webapp/src/main/java/sonia/scm/api/v2/resources/ConfigDto.java
View File

@@ -62,6 +62,7 @@ public class ConfigDto extends HalRepresentation implements UpdateConfigDto {
private String loginInfoUrl;
private String releaseFeedUrl;
private String mailDomainName;
private Set<String> emergencyContacts;
@Override
@SuppressWarnings("squid:S1185") // We want to have this method available in this package

2
scm-webapp/src/main/java/sonia/scm/api/v2/resources/UpdateConfigDto.java
View File

@@ -74,4 +74,6 @@ interface UpdateConfigDto {
String getReleaseFeedUrl();
String getMailDomainName();
Set<String> getEmergencyContacts();
}

49
scm-webapp/src/main/java/sonia/scm/repository/HealthChecker.java
View File

@@ -25,9 +25,14 @@
package sonia.scm.repository;
import com.google.inject.Inject;
import org.apache.shiro.SecurityUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import sonia.scm.NotFoundException;
import sonia.scm.config.ScmConfiguration;
import sonia.scm.notifications.Notification;
import sonia.scm.notifications.NotificationSender;
import sonia.scm.notifications.Type;
import sonia.scm.repository.api.Command;
import sonia.scm.repository.api.RepositoryService;
import sonia.scm.repository.api.RepositoryServiceFactory;
@@ -59,15 +64,22 @@ final class HealthChecker {
private final ExecutorService healthCheckExecutor = Executors.newSingleThreadExecutor();
private final ScmConfiguration scmConfiguration;
private final NotificationSender notificationSender;
@Inject
HealthChecker(Set<HealthCheck> checks,
RepositoryManager repositoryManager,
RepositoryServiceFactory repositoryServiceFactory,
RepositoryPostProcessor repositoryPostProcessor) {
RepositoryPostProcessor repositoryPostProcessor,
ScmConfiguration scmConfiguration,
NotificationSender notificationSender) {
this.checks = checks;
this.repositoryManager = repositoryManager;
this.repositoryServiceFactory = repositoryServiceFactory;
this.repositoryPostProcessor = repositoryPostProcessor;
this.scmConfiguration = scmConfiguration;
this.notificationSender = notificationSender;
}
void lightCheck(String id) {
@@ -155,13 +167,14 @@ final class HealthChecker {
private void doFullCheck(Repository repository) {
withLockedRepository(repository, () ->
runInExecutorAndWait(repository, () -> {
HealthCheckResult lightCheckResult = gatherLightChecks(repository);
HealthCheckResult fullCheckResult = gatherFullChecks(repository);
HealthCheckResult result = lightCheckResult.merge(fullCheckResult);
runInExecutorAndWait(repository, () -> {
HealthCheckResult lightCheckResult = gatherLightChecks(repository);
HealthCheckResult fullCheckResult = gatherFullChecks(repository);
HealthCheckResult result = lightCheckResult.merge(fullCheckResult);
storeResult(repository, result);
})
notifyCurrentUser(repository, result);
storeResult(repository, result);
})
);
}
@@ -204,10 +217,32 @@ final class HealthChecker {
logger.trace("store health check results for repository {}",
repository);
repositoryPostProcessor.setCheckResults(repository, result.getFailures());
notifyEmergencyContacts(repository);
}
}
public boolean checkRunning(String repositoryId) {
return checksRunning.contains(repositoryId);
}
private void notifyCurrentUser(Repository repository, HealthCheckResult result) {
if (!(repository.isHealthy() && result.isHealthy())) {
String currentUser = SecurityUtils.getSubject().getPrincipal().toString();
if (!scmConfiguration.getEmergencyContacts().contains(currentUser)) {
notificationSender.send(getHealthCheckFailedNotification(repository));
}
}
}
private void notifyEmergencyContacts(Repository repository) {
Set<String> emergencyContacts = scmConfiguration.getEmergencyContacts();
for (String user : emergencyContacts) {
notificationSender.send(getHealthCheckFailedNotification(repository), user);
}
}
private Notification getHealthCheckFailedNotification(Repository repository) {
return new Notification(Type.ERROR, "/repo/" + repository.getNamespaceAndName() + "/settings/general", "healthCheckFailed");
}
}