org.graylog2.indexer.fieldtypes

Class IndexFieldTypePollerPeriodical

java.lang.Object

org.graylog2.plugin.periodical.Periodical

org.graylog2.indexer.fieldtypes.IndexFieldTypePollerPeriodical

All Implemented Interfaces:

Runnable

public class IndexFieldTypePollerPeriodical
extends Periodical

Periodical that creates and maintains index field type information in the database.

Constructor Summary

Constructors

Constructor and Description
IndexFieldTypePollerPeriodical(IndexFieldTypePoller poller, IndexFieldTypesService dbService, IndexSetService indexSetService, Indices indices, MongoIndexSet.Factory mongoIndexSetFactory, Cluster cluster, com.google.common.eventbus.EventBus eventBus, ServerStatus serverStatus, com.github.joschi.jadconfig.util.Duration periodicalInterval, ScheduledExecutorService scheduler)

Method Summary

Modifier and Type	Method and Description
void	doRun() This creates index field type information for each index in each index set and schedules polling jobs to keep the data for active write indices up to date.
int	getInitialDelaySeconds()
protected org.slf4j.Logger	getLogger()
int	getPeriodSeconds()
void	handleIndexDeletion(IndicesDeletedEvent event) Removes the index field type data for the deleted index.
void	handleIndexSetCreation(IndexSetCreatedEvent event) Creates a new field type polling job for the newly created index set.
void	handleIndexSetDeletion(IndexSetDeletedEvent event) Removes the field type polling job for the now deleted index set.
boolean	isDaemon() Should this periodical be run as a daemon thread?
boolean	masterOnly() Only start this thread on master nodes?
boolean	runsForever() Defines if this thread should be called periodically or only once on startup.
boolean	startOnThisNode() Start on this node? Useful to decide if to start the periodical based on local configuration.
boolean	stopOnGracefulShutdown() Should this thread be stopped when a graceful shutdown is in progress? This means that stop() is called and that is no longer triggered periodically.

Methods inherited from class org.graylog2.plugin.periodical.Periodical

getParallelism, initialize, run

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexFieldTypePollerPeriodical

@Inject
public IndexFieldTypePollerPeriodical(IndexFieldTypePoller poller,
                                              IndexFieldTypesService dbService,
                                              IndexSetService indexSetService,
                                              Indices indices,
                                              MongoIndexSet.Factory mongoIndexSetFactory,
                                              Cluster cluster,
                                              com.google.common.eventbus.EventBus eventBus,
                                              ServerStatus serverStatus,
                                              @Named(value="index_field_type_periodical_interval")
                                              com.github.joschi.jadconfig.util.Duration periodicalInterval,
                                              @Named(value="daemonScheduler")
                                              ScheduledExecutorService scheduler)

Method Detail

doRun

public void doRun()

This creates index field type information for each index in each index set and schedules polling jobs to keep the data for active write indices up to date. It also removes index field type data for indices that don't exist anymore.

Since we create polling jobs for the active write indices, this periodical doesn't need to be run very often.

Specified by:

doRun in class Periodical

handleIndexSetCreation

public void handleIndexSetCreation(IndexSetCreatedEvent event)

Creates a new field type polling job for the newly created index set.

Parameters:

event - index set creation event

handleIndexSetDeletion

public void handleIndexSetDeletion(IndexSetDeletedEvent event)

Removes the field type polling job for the now deleted index set.

Parameters:

event - index set deletion event

handleIndexDeletion

public void handleIndexDeletion(IndicesDeletedEvent event)

Removes the index field type data for the deleted index.

Parameters:

event - index deletion event

runsForever

public boolean runsForever()

Description copied from class: Periodical

Defines if this thread should be called periodically or only once on startup.

Specified by:

runsForever in class Periodical

Returns:

stopOnGracefulShutdown

public boolean stopOnGracefulShutdown()

Description copied from class: Periodical

Should this thread be stopped when a graceful shutdown is in progress? This means that stop() is called and that is no longer triggered periodically.

Specified by:

stopOnGracefulShutdown in class Periodical

Returns:

masterOnly

public boolean masterOnly()

Description copied from class: Periodical

Only start this thread on master nodes?

Specified by:

masterOnly in class Periodical

Returns:

startOnThisNode

public boolean startOnThisNode()

Description copied from class: Periodical

Start on this node? Useful to decide if to start the periodical based on local configuration.

Specified by:

startOnThisNode in class Periodical

Returns:

isDaemon

public boolean isDaemon()

Description copied from class: Periodical

Should this periodical be run as a daemon thread?

Specified by:

isDaemon in class Periodical

Returns:

getInitialDelaySeconds

public int getInitialDelaySeconds()

Specified by:

getInitialDelaySeconds in class Periodical

Returns:

Seconds to wait before starting the thread. 0 for runsForever() threads.

getPeriodSeconds

public int getPeriodSeconds()

Specified by:

getPeriodSeconds in class Periodical

Returns:

How long to wait between each execution of the thread. 0 for runsForever() threads.

getLogger

protected org.slf4j.Logger getLogger()

Specified by:

getLogger in class Periodical