Module org.elasticsearch.server

Package org.elasticsearch.health

Class HealthPeriodicLogger

java.lang.Object

org.elasticsearch.health.HealthPeriodicLogger

All Implemented Interfaces:

Closeable, AutoCloseable, ClusterStateListener, SchedulerEngine.Listener

public class HealthPeriodicLogger
extends Object
implements ClusterStateListener, Closeable, SchedulerEngine.Listener

This class periodically logs the results of the Health API to the standard Elasticsearch server log file.

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<Boolean>	ENABLED_SETTING
static final String	HEALTH_FIELD_PREFIX
protected static final String	HEALTH_PERIODIC_LOGGER_JOB_NAME	Name constant for the job HealthService schedules
static final String	MESSAGE_FIELD
static final Setting<TimeValue>	POLL_INTERVAL_SETTING

Method Summary

Modifier and Type	Method	Description
void	close()
void	clusterChanged(ClusterChangedEvent event)	Called when cluster state changes.
static HealthPeriodicLogger	create(Settings settings, ClusterService clusterService, Client client, HealthService healthService)	Creates a new HealthPeriodicLogger.
void	triggered(SchedulerEngine.Event event)

Methods inherited from class java.lang.Object

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

Field Details

HEALTH_FIELD_PREFIX

public static final String HEALTH_FIELD_PREFIX

See Also:

• Constant Field Values

MESSAGE_FIELD

public static final String MESSAGE_FIELD

See Also:

• Constant Field Values

POLL_INTERVAL_SETTING

public static final Setting<TimeValue> POLL_INTERVAL_SETTING

ENABLED_SETTING

public static final Setting<Boolean> ENABLED_SETTING

HEALTH_PERIODIC_LOGGER_JOB_NAME

protected static final String HEALTH_PERIODIC_LOGGER_JOB_NAME

Name constant for the job HealthService schedules

See Also:

• Constant Field Values

Method Details

create

public static HealthPeriodicLogger create(Settings settings,
 ClusterService clusterService,
 Client client,
 HealthService healthService)

Creates a new HealthPeriodicLogger. This creates a scheduled job using the SchedulerEngine framework and runs it on the current health node.

Parameters:

settings - the cluster settings, used to get the interval setting.

clusterService - the cluster service, used to know when the health node changes.

client - the client used to call the Health Service.

healthService - the Health Service, where the actual Health API logic lives.

clusterChanged

public void clusterChanged(ClusterChangedEvent event)

Description copied from interface: ClusterStateListener

Called when cluster state changes.

Cluster states are applied one-by-one which means they can be a performance bottleneck. Implementations of this method should therefore be fast, so please consider forking work into the background rather than doing everything inline.

Specified by:

clusterChanged in interface ClusterStateListener

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

triggered

public void triggered(SchedulerEngine.Event event)

Specified by:

triggered in interface SchedulerEngine.Listener