Package ch.rswk.meta.engine

Class LoggingService

java.lang.Object

com.google.common.util.concurrent.AbstractIdleService

ch.rswk.meta.engine.AbstractEngineIdleService<LoggingService.LoggingServiceConfig>

ch.rswk.meta.engine.LoggingService

All Implemented Interfaces:

EngineServices.ConfigurableService<LoggingService.LoggingServiceConfig>, EngineServices.InfoProvidingService, com.google.common.util.concurrent.Service

@Singleton
public class LoggingService
extends AbstractEngineIdleService<LoggingService.LoggingServiceConfig>

LoggingService for storing and searching for logs and metrics. Uses a LuceneService instance to store logging data.

Attatches to SLF4J root logger and persists entries Level.INFO and above on the server side. Clients can use Logging or meta-client/logging module to persist client data as well.

See Also:

• Protocol.newLoggingEntry(ILoggingEvent)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	LoggingService.FilesHealthCheck
static final record	LoggingService.LoggingServiceAlertConfig
static final record	LoggingService.LoggingServiceConfig
static final record	LoggingService.LoggingServiceRetentionPathConfig

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 org.slf4j.Logger	ALERT_LOG
private static final String	ALERT_MESSAGE_FORMAT
static final Duration	ALERT_SCHEDULE
private static final String	ALERT_SUBJECT
private ScheduledFuture<?>	alertHandle
private com.codahale.metrics.Meter	alertMeter
private ch.qos.logback.core.UnsynchronizedAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>	appender
private static final String	DELETE_BEFORE_FORMAT
private static final Protocol.ErrorReplyFactory	DELETE_ERROR
private com.codahale.metrics.Meter	deleteMeter
private final GatewayService	gatewayService
private static final org.slf4j.Logger	LOG
private com.codahale.metrics.Meter	logErrorMeter
private static final com.fasterxml.jackson.databind.ObjectReader	LOGGING_ENTRY_READER
private static final com.fasterxml.jackson.databind.ObjectReader	LOGGING_METRIC_READER
private com.codahale.metrics.Meter	logMetricMeter
private com.codahale.metrics.Meter	logWarnMeter
private final LuceneService	luceneService
private static final com.fasterxml.jackson.databind.ObjectMapper	MAPPER
private static final Set<String>	METRIC_DEFAULT_FILTER
private static final Protocol.ErrorReplyFactory	METRIC_NAME_ERROR
private static final Protocol.ErrorReplyFactory	NO_QUERY_ERROR
private String	previousAlertNames
private ScheduledFuture<?>	retentionHandle
private static final Protocol.ErrorReplyFactory	SEARCH_ERROR
private com.codahale.metrics.Meter	searchMeter
private static final Duration	TIMER_EXPIRATION
private com.github.benmanes.caffeine.cache.Cache<String,com.codahale.metrics.Timer.Context>	timerCache
private static final Protocol.ErrorReplyFactory	WRITE_ERROR
private com.codahale.metrics.Meter	writeErrorMeter
private com.codahale.metrics.Meter	writeMeter

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

runtime

Constructor Summary

Constructors

Constructor	Description
LoggingService(LoggingService.LoggingServiceConfig config, GatewayService gatewayService, LuceneService luceneService, EngineRuntime runtime)

Method Summary

Modifier and Type	Method	Description
private void	checkRetention()
private static void	checkRetentionPath(LoggingService.LoggingServiceRetentionPathConfig pathConfig)
private void	checkRetentionPaths()
private static float	getMetricSamplingPercentage(float sampling)
void	log(LoggingMessage request)
com.google.common.util.concurrent.ListenableFuture<LoggingDeleteReply>	loggingDelete(LoggingDeleteRequest request)
com.google.common.util.concurrent.ListenableFuture<LoggingEntrySearchReply>	loggingEntrySearch(LoggingEntrySearchRequest request)
com.google.common.util.concurrent.ListenableFuture<LoggingMetricSearchReply>	loggingMetricSearch(LoggingMetricSearchRequest request)
com.google.common.util.concurrent.ListenableFuture<LoggingMetricTimeReply>	loggingMetricTime(LoggingMetricTimeRequest request)
private static @Nullable Iterable<String>	newMetricFilter(@Nullable List<String> filter)
void	onConfigChanged()
private void	processAlertsAndMetrics()
private com.google.common.util.concurrent.ListenableFuture<LuceneService.SearchResult>	searchLucene(String cursor, int limit, LuceneService luceneService, MetaLucene.QueryContext queryContext)
com.google.common.util.concurrent.ListenableFuture<Boolean>	sendAlerts(List<AlertRegistry.Alert> alerts)
protected void	shutDown()
protected void	startUp()
private void	updateLoggers()
private void	writeLoggingEntry(LoggingEntry entry)
private com.google.common.util.concurrent.ListenableFuture<Long>	writeLoggingMetric()

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

ALERT_SCHEDULE

public static final Duration ALERT_SCHEDULE

ALERT_SUBJECT

private static final String ALERT_SUBJECT

See Also:

• Constant Field Values

ALERT_LOG

private static final org.slf4j.Logger ALERT_LOG

ALERT_MESSAGE_FORMAT

private static final String ALERT_MESSAGE_FORMAT

See Also:

• Constant Field Values

DELETE_BEFORE_FORMAT

private static final String DELETE_BEFORE_FORMAT

See Also:

• Constant Field Values

DELETE_ERROR

private static final Protocol.ErrorReplyFactory DELETE_ERROR

MAPPER

private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER

LOGGING_ENTRY_READER

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

LOGGING_METRIC_READER

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

METRIC_DEFAULT_FILTER

private static final Set<String> METRIC_DEFAULT_FILTER

METRIC_NAME_ERROR

private static final Protocol.ErrorReplyFactory METRIC_NAME_ERROR

NO_QUERY_ERROR

private static final Protocol.ErrorReplyFactory NO_QUERY_ERROR

SEARCH_ERROR

private static final Protocol.ErrorReplyFactory SEARCH_ERROR

TIMER_EXPIRATION

private static final Duration TIMER_EXPIRATION

WRITE_ERROR

private static final Protocol.ErrorReplyFactory WRITE_ERROR

gatewayService

private final GatewayService gatewayService

luceneService

private final LuceneService luceneService

alertHandle

private ScheduledFuture<?> alertHandle

alertMeter

private com.codahale.metrics.Meter alertMeter

appender

private ch.qos.logback.core.UnsynchronizedAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent> appender

deleteMeter

private com.codahale.metrics.Meter deleteMeter

logErrorMeter

private com.codahale.metrics.Meter logErrorMeter

logMetricMeter

private com.codahale.metrics.Meter logMetricMeter

logWarnMeter

private com.codahale.metrics.Meter logWarnMeter

previousAlertNames

private String previousAlertNames

retentionHandle

private ScheduledFuture<?> retentionHandle

searchMeter

private com.codahale.metrics.Meter searchMeter

timerCache

private com.github.benmanes.caffeine.cache.Cache<String,com.codahale.metrics.Timer.Context> timerCache

writeErrorMeter

private com.codahale.metrics.Meter writeErrorMeter

writeMeter

private com.codahale.metrics.Meter writeMeter

Constructor Details

LoggingService

@Inject
public LoggingService(LoggingService.LoggingServiceConfig config,
 GatewayService gatewayService,
 @Named("Logging")
 LuceneService luceneService,
 EngineRuntime runtime)

Method Details

startUp

protected void startUp()
                throws Exception

Overrides:

startUp in class AbstractEngineIdleService<LoggingService.LoggingServiceConfig>

Throws:

Exception

processAlertsAndMetrics

private void processAlertsAndMetrics()

sendAlerts

public com.google.common.util.concurrent.ListenableFuture<Boolean> sendAlerts(List<AlertRegistry.Alert> alerts)

writeLoggingMetric

private com.google.common.util.concurrent.ListenableFuture<Long> writeLoggingMetric()

checkRetention

private void checkRetention()

checkRetentionPaths

private void checkRetentionPaths()

checkRetentionPath

private static void checkRetentionPath(LoggingService.LoggingServiceRetentionPathConfig pathConfig)

shutDown

protected void shutDown()
                 throws Exception

Overrides:

shutDown in class AbstractEngineIdleService<LoggingService.LoggingServiceConfig>

Throws:

Exception

onConfigChanged

public void onConfigChanged()

updateLoggers

private void updateLoggers()

log

public void log(LoggingMessage request)

writeLoggingEntry

private void writeLoggingEntry(LoggingEntry entry)

loggingEntrySearch

public com.google.common.util.concurrent.ListenableFuture<LoggingEntrySearchReply> loggingEntrySearch(LoggingEntrySearchRequest request)

loggingMetricTime

public com.google.common.util.concurrent.ListenableFuture<LoggingMetricTimeReply> loggingMetricTime(LoggingMetricTimeRequest request)

loggingMetricSearch

public com.google.common.util.concurrent.ListenableFuture<LoggingMetricSearchReply> loggingMetricSearch(LoggingMetricSearchRequest request)

newMetricFilter

private static @Nullable Iterable<String> newMetricFilter(@Nullable List<String> filter)

getMetricSamplingPercentage

private static float getMetricSamplingPercentage(float sampling)

searchLucene

private com.google.common.util.concurrent.ListenableFuture<LuceneService.SearchResult> searchLucene(String cursor,
 int limit,
 LuceneService luceneService,
 MetaLucene.QueryContext queryContext)

loggingDelete

public com.google.common.util.concurrent.ListenableFuture<LoggingDeleteReply> loggingDelete(LoggingDeleteRequest request)