Package org.graylog2.system.processing

Class DBProcessingStatusService

java.lang.Object

org.graylog2.system.processing.DBProcessingStatusService

public class DBProcessingStatusService
extends Object

Manages the database collection for processing status.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DBProcessingStatusService.ProcessingNodesState

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLLECTION_NAME

Constructor Summary

Constructors

Constructor	Description
DBProcessingStatusService(MongoConnection mongoConnection, NodeId nodeId, JobSchedulerClock clock, com.github.joschi.jadconfig.util.Duration updateThreshold, int journalWriteRateThreshold, MongoJackObjectMapperProvider mapper, BaseConfiguration baseConfiguration)

Method Summary

Modifier and Type	Method	Description
List<ProcessingStatusDto>	all()	Rerturns all existing processing status entries from the database.
DBProcessingStatusService.ProcessingNodesState	calculateProcessingState(TimeRange timeRange)	Calculates the processing state of all active Graylog nodes in the cluster.
Optional<ProcessingStatusDto>	get()	Returns the processing status entry for the calling node.
ProcessingStatusDto	save(ProcessingStatusRecorder processingStatusRecorder)	Create or update (upsert) a processing status entry for the given ProcessingStatusRecorder using the caller's node ID.

Methods inherited from class java.lang.Object

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

Field Details

COLLECTION_NAME

public static final String COLLECTION_NAME

See Also:

• Constant Field Values

Constructor Details

DBProcessingStatusService

@Inject
public DBProcessingStatusService(MongoConnection mongoConnection,
 NodeId nodeId,
 JobSchedulerClock clock,
 @Named("processing_status_update_threshold")
 com.github.joschi.jadconfig.util.Duration updateThreshold,
 @Named("processing_status_journal_write_rate_threshold")
 int journalWriteRateThreshold,
 MongoJackObjectMapperProvider mapper,
 BaseConfiguration baseConfiguration)

Method Details

all

public List<ProcessingStatusDto> all()

Rerturns all existing processing status entries from the database.

Returns:

a list of all processing status entries

get

public Optional<ProcessingStatusDto> get()

Returns the processing status entry for the calling node.

Returns:

the processing status entry or an empty optional if none exists

save

public ProcessingStatusDto save(ProcessingStatusRecorder processingStatusRecorder)

Create or update (upsert) a processing status entry for the given ProcessingStatusRecorder using the caller's node ID.

Parameters:

processingStatusRecorder - the processing recorder object to create/update

Returns:

the created/updated entry

calculateProcessingState

public DBProcessingStatusService.ProcessingNodesState calculateProcessingState(TimeRange timeRange)

Calculates the processing state of all active Graylog nodes in the cluster. This can be used to find out if a certain timerange is already searchable in Elastic / OpenSearch.

Beware: This only takes the message receive time into account. It doesn't help when log sources send their messages late.

Returns:

A combined state of all processing nodes in this cluster. See DBProcessingStatusService.ProcessingNodesState