Package ch.rswk.meta.engine

Class WatchdogService

java.lang.Object

com.google.common.util.concurrent.AbstractIdleService

ch.rswk.meta.engine.AbstractEngineIdleService<WatchdogService.WatchdogServiceConfig>

ch.rswk.meta.engine.WatchdogService

All Implemented Interfaces:

EngineServices.ConfigurableService<WatchdogService.WatchdogServiceConfig>, EngineServices.InfoProvidingService, com.google.common.util.concurrent.Service

@Singleton
public class WatchdogService
extends AbstractEngineIdleService<WatchdogService.WatchdogServiceConfig>

WatchdogService can report engine health to another engine (usually a central, dedicated watchdog), check if other runtimes are healthy (as the dedicated watchdog) and schedule/process automated updates.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	WatchdogService.EnginesHealthCheck
static final record	WatchdogService.WatchdogServiceCheckConfig
static final record	WatchdogService.WatchdogServiceConfig
static final record	WatchdogService.WatchdogServiceReportConfig

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	CHECK_LOG_QUERY_FORMAT
private ScheduledFuture<?>	checkHandle
private Duration	checkSchedule
private static final Duration	DEFAULT_CHECK_SCHEDULE
private static final Duration	DEFAULT_REPORT_SCHEDULE
private static final VariableResolver	ENGINE_RESOLVER
private io.reactivex.rxjava3.disposables.Disposable	fileExpirationSub
private final FileService	fileService
private org.eclipse.jetty.client.HttpClient	httpClient
static final String	LOCALHOST_REPORT_ENGINE
private static final org.slf4j.Logger	LOG
private final MetaService	metaService
private RestClient	restClient
private ScheduledFuture<?>	retentionHandle
private com.codahale.metrics.Meter	sendStatusErrorMeter
private static final String	STATUS_BASE_QUERY
private static final String	STATUS_ENGINE_ID_QUERY_FORMAT
private static final com.fasterxml.jackson.databind.JsonNode	STATUS_HEALTHY_UPDATE
private static final Set<String>	STATUS_LOG_PURGE
private static final String	STATUS_LOG_QUERY_FORMAT
private static final com.fasterxml.jackson.databind.ObjectReader	STATUS_REPLY_READER
private static final com.fasterxml.jackson.databind.JsonNode	STATUS_UNHEALTHY_UPDATE
private static final com.fasterxml.jackson.databind.ObjectWriter	STATUS_WRITER
private ScheduledFuture<?>	statusHandle
private com.codahale.metrics.Meter	statusMeter
private final Set<String>	unhealthyEngines
private static final String	UPDATE_ARCHIVE_FILE
private static final String	UPDATE_STATUS_HEALTHY
private static final String	UPDATE_STATUS_UNHEALTHY
private com.codahale.metrics.Meter	updateStatusMeter
private final UserService	userService

Fields inherited from class ch.rswk.meta.engine.AbstractEngineIdleService

runtime

Constructor Summary

Constructors

Constructor	Description
WatchdogService(WatchdogService.WatchdogServiceConfig config, FileService fileService, MetaService metaService, EngineRuntime runtime, UserService userService)

Method Summary

Modifier and Type	Method	Description
private void	checkEngines()
private void	checkRetention()
private com.google.common.util.concurrent.ListenableFuture<Void>	downloadLocalUpdate(String fileKey, Path updateFile)
private com.google.common.util.concurrent.ListenableFuture<Void>	downloadRemoteUpdate(String engine, String fileKey, Path updateFile)
private com.google.common.util.concurrent.ListenableFuture<MetaObject>	loadStatus(String engineId)
private WatchdogStatus	newStatus()
void	onConfigChanged()
private void	onFileExpirationNotification(FileService.FileExpirationNotification notification)
private com.google.common.util.concurrent.ListenableFuture<Void>	processUpdate(WatchdogStatusUpdate update)
com.google.common.util.concurrent.ListenableFuture<WatchdogStatusReply>	receiveStatus(WatchdogStatus status)
void	receiveUpdateStatus(WatchdogStatusUpdateStatus updateStatus)
private void	scheduleReportAndCheckHandles()
private com.google.common.util.concurrent.ListenableFuture<WatchdogStatusReply>	sendStatus(WatchdogStatus status)
private void	sendStatusAndProcessUpdate()
protected void	shutDown()
protected void	startUp()
Set<String>	unhealthyEngines()

Methods inherited from class ch.rswk.meta.engine.AbstractEngineIdleService

configClass, configReference, serviceName

Methods inherited from class com.google.common.util.concurrent.AbstractIdleService

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, executor, failureCause, isRunning, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.rswk.meta.engine.EngineServices.ConfigurableService

config

Methods inherited from interface ch.rswk.meta.engine.EngineServices.InfoProvidingService

getServiceInfo

Field Details

LOG

private static final org.slf4j.Logger LOG

LOCALHOST_REPORT_ENGINE

public static final String LOCALHOST_REPORT_ENGINE

See Also:

• Constant Field Values

CHECK_LOG_QUERY_FORMAT

private static final String CHECK_LOG_QUERY_FORMAT

See Also:

• Constant Field Values

DEFAULT_CHECK_SCHEDULE

private static final Duration DEFAULT_CHECK_SCHEDULE

DEFAULT_REPORT_SCHEDULE

private static final Duration DEFAULT_REPORT_SCHEDULE

ENGINE_RESOLVER

private static final VariableResolver ENGINE_RESOLVER

STATUS_BASE_QUERY

private static final String STATUS_BASE_QUERY

See Also:

• Constant Field Values

STATUS_ENGINE_ID_QUERY_FORMAT

private static final String STATUS_ENGINE_ID_QUERY_FORMAT

See Also:

• Constant Field Values

STATUS_HEALTHY_UPDATE

private static final com.fasterxml.jackson.databind.JsonNode STATUS_HEALTHY_UPDATE

STATUS_LOG_PURGE

private static final Set<String> STATUS_LOG_PURGE

STATUS_LOG_QUERY_FORMAT

private static final String STATUS_LOG_QUERY_FORMAT

STATUS_REPLY_READER

private static final com.fasterxml.jackson.databind.ObjectReader STATUS_REPLY_READER

STATUS_UNHEALTHY_UPDATE

private static final com.fasterxml.jackson.databind.JsonNode STATUS_UNHEALTHY_UPDATE

STATUS_WRITER

private static final com.fasterxml.jackson.databind.ObjectWriter STATUS_WRITER

UPDATE_ARCHIVE_FILE

private static final String UPDATE_ARCHIVE_FILE

See Also:

• Constant Field Values

UPDATE_STATUS_HEALTHY

private static final String UPDATE_STATUS_HEALTHY

See Also:

• Constant Field Values

UPDATE_STATUS_UNHEALTHY

private static final String UPDATE_STATUS_UNHEALTHY

See Also:

• Constant Field Values

fileService

private final FileService fileService

metaService

private final MetaService metaService

unhealthyEngines

private final Set<String> unhealthyEngines

userService

private final UserService userService

checkHandle

private ScheduledFuture<?> checkHandle

checkSchedule

private Duration checkSchedule

fileExpirationSub

private io.reactivex.rxjava3.disposables.Disposable fileExpirationSub

httpClient

private org.eclipse.jetty.client.HttpClient httpClient

restClient

private RestClient restClient

retentionHandle

private ScheduledFuture<?> retentionHandle

sendStatusErrorMeter

private com.codahale.metrics.Meter sendStatusErrorMeter

statusHandle

private ScheduledFuture<?> statusHandle

statusMeter

private com.codahale.metrics.Meter statusMeter

updateStatusMeter

private com.codahale.metrics.Meter updateStatusMeter

Constructor Details

WatchdogService

@Inject
public WatchdogService(WatchdogService.WatchdogServiceConfig config,
 FileService fileService,
 MetaService metaService,
 EngineRuntime runtime,
 UserService userService)

Method Details

startUp

protected void startUp()
                throws Exception

Overrides:

startUp in class AbstractEngineIdleService<WatchdogService.WatchdogServiceConfig>

Throws:

Exception

shutDown

protected void shutDown()
                 throws Exception

Overrides:

shutDown in class AbstractEngineIdleService<WatchdogService.WatchdogServiceConfig>

Throws:

Exception

onConfigChanged

public void onConfigChanged()

scheduleReportAndCheckHandles

private void scheduleReportAndCheckHandles()

sendStatusAndProcessUpdate

private void sendStatusAndProcessUpdate()

newStatus

private WatchdogStatus newStatus()

sendStatus

private com.google.common.util.concurrent.ListenableFuture<WatchdogStatusReply> sendStatus(WatchdogStatus status)

processUpdate

private com.google.common.util.concurrent.ListenableFuture<Void> processUpdate(WatchdogStatusUpdate update)

downloadLocalUpdate

private com.google.common.util.concurrent.ListenableFuture<Void> downloadLocalUpdate(String fileKey,
 Path updateFile)

downloadRemoteUpdate

private com.google.common.util.concurrent.ListenableFuture<Void> downloadRemoteUpdate(String engine,
 String fileKey,
 Path updateFile)

receiveStatus

public com.google.common.util.concurrent.ListenableFuture<WatchdogStatusReply> receiveStatus(WatchdogStatus status)

receiveUpdateStatus

public void receiveUpdateStatus(WatchdogStatusUpdateStatus updateStatus)

loadStatus

private com.google.common.util.concurrent.ListenableFuture<MetaObject> loadStatus(String engineId)

checkEngines

private void checkEngines()

unhealthyEngines

public Set<String> unhealthyEngines()

checkRetention

private void checkRetention()

onFileExpirationNotification

private void onFileExpirationNotification(FileService.FileExpirationNotification notification)