org.graylog2.indexer.indices

Class Indices

java.lang.Object

org.graylog2.indexer.indices.Indices

@Singleton
public class Indices
extends Object

Constructor Summary

Constructors

Constructor and Description
Indices(io.searchbox.client.JestClient jestClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper, IndexMappingFactory indexMappingFactory, Messages messages, NodeId nodeId, AuditEventSender auditEventSender, com.google.common.eventbus.EventBus eventBus)

Method Summary

Modifier and Type	Method and Description
boolean	aliasExists(String alias) Check if a given name is an existing alias.
Optional<String>	aliasTarget(String alias)
Map<String,Boolean>	areReopened(Collection<String> indices)
void	close(String indexName)
boolean	create(String indexName, IndexSet indexSet)
boolean	create(String indexName, IndexSet indexSet, Map<String,Object> customSettings)
void	cycleAlias(String aliasName, String targetIndex)
void	cycleAlias(String aliasName, String targetIndex, String oldIndex)
void	delete(String indexName)
void	deleteIndexTemplate(IndexSet indexSet)
void	ensureIndexTemplate(IndexSet indexSet)
boolean	exists(String indexName) Check if a given name is an existing index.
void	flush(String index)
Set<String>	getAllMessageFields(String[] writeIndexWildcards)
Map<String,Set<String>>	getAllMessageFieldsForIndices(String[] writeIndexWildcards)
Set<String>	getClosedIndices(Collection<String> indices)
Set<String>	getClosedIndices(IndexSet indexSet)
@NotNull Map<String,Set<String>>	getIndexNamesAndAliases(String indexPattern) Returns index names and their aliases.
com.fasterxml.jackson.databind.JsonNode	getIndexStats(IndexSet indexSet)
Optional<IndexStatistics>	getIndexStats(String index)
Map<String,Object>	getIndexTemplate(IndexSet indexSet) Returns the generated Elasticsearch index template for the given index set.
Set<String>	getIndices(IndexSet indexSet, String... statusFilter) Retrieves all indices in the given IndexSet.
Set<IndexStatistics>	getIndicesStats(Collection<String> indices)
Set<IndexStatistics>	getIndicesStats(IndexSet indexSet)
Set<String>	getReopenedIndices(Collection<String> indices)
Set<String>	getReopenedIndices(IndexSet indexSet)
Optional<Long>	getStoreSizeInBytes(String index)
Optional<org.joda.time.DateTime>	indexCreationDate(String index)
IndexRangeStats	indexRangeStatsOfIndex(String index) Calculate min and max message timestamps in the given index.
boolean	isClosed(String indexName)
boolean	isReopened(String indexName)
String	markIndexReopened(String index)
void	move(String source, String target)
long	numberOfMessages(String indexName)
void	optimizeIndex(String index, int maxNumSegments, com.github.joschi.jadconfig.util.Duration timeout)
void	removeAliases(String alias, Set<String> indices)
void	reopenIndex(String index)
void	setReadOnly(String index)
io.searchbox.cluster.Health.Status	waitForRecovery(String index)

Methods inherited from class java.lang.Object

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

Constructor Detail

Indices

@Inject
public Indices(io.searchbox.client.JestClient jestClient,
                       com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                       IndexMappingFactory indexMappingFactory,
                       Messages messages,
                       NodeId nodeId,
                       AuditEventSender auditEventSender,
                       com.google.common.eventbus.EventBus eventBus)

Method Detail

move

public void move(String source,
                 String target)

delete

public void delete(String indexName)

close

public void close(String indexName)

numberOfMessages

public long numberOfMessages(String indexName)
                      throws IndexNotFoundException

Throws:

IndexNotFoundException

getIndexStats

public com.fasterxml.jackson.databind.JsonNode getIndexStats(IndexSet indexSet)

exists

public boolean exists(String indexName)

Check if a given name is an existing index.

Parameters:

indexName - Name of the index to check presence for.

Returns:

true if indexName is an existing index, false if it is non-existing or an alias.

aliasExists

public boolean aliasExists(String alias)

Check if a given name is an existing alias.

Parameters:

alias - Name of the alias to check presence for.

Returns:

true if alias is an existing alias, false if it is non-existing or an index.

getIndexNamesAndAliases

@NotNull
public @NotNull Map<String,Set<String>> getIndexNamesAndAliases(String indexPattern)

Returns index names and their aliases. This only returns indices which actually have an alias.

aliasTarget

public Optional<String> aliasTarget(String alias)
                             throws TooManyAliasesException

Throws:

TooManyAliasesException

ensureIndexTemplate

public void ensureIndexTemplate(IndexSet indexSet)

getIndexTemplate

public Map<String,Object> getIndexTemplate(IndexSet indexSet)

Returns the generated Elasticsearch index template for the given index set.

Parameters:

indexSet - the index set

Returns:

the generated index template

deleteIndexTemplate

public void deleteIndexTemplate(IndexSet indexSet)

create

public boolean create(String indexName,
                      IndexSet indexSet)

create

public boolean create(String indexName,
                      IndexSet indexSet,
                      Map<String,Object> customSettings)

getAllMessageFieldsForIndices

public Map<String,Set<String>> getAllMessageFieldsForIndices(String[] writeIndexWildcards)

getAllMessageFields

public Set<String> getAllMessageFields(String[] writeIndexWildcards)

setReadOnly

public void setReadOnly(String index)

flush

public void flush(String index)

reopenIndex

public void reopenIndex(String index)

markIndexReopened

public String markIndexReopened(String index)

isReopened

public boolean isReopened(String indexName)

areReopened

public Map<String,Boolean> areReopened(Collection<String> indices)

getClosedIndices

public Set<String> getClosedIndices(Collection<String> indices)

getClosedIndices

public Set<String> getClosedIndices(IndexSet indexSet)

getIndices

public Set<String> getIndices(IndexSet indexSet,
                              String... statusFilter)

Retrieves all indices in the given IndexSet.

If any status filter parameter are present, only indices with the given status are returned.

Parameters:

indexSet - the index set

statusFilter - only indices with the given status are returned. (available: "open", "close")

Returns:

the set of indices in the given index set

isClosed

public boolean isClosed(String indexName)

getReopenedIndices

public Set<String> getReopenedIndices(Collection<String> indices)

getReopenedIndices

public Set<String> getReopenedIndices(IndexSet indexSet)

getIndexStats

public Optional<IndexStatistics> getIndexStats(String index)

getStoreSizeInBytes

public Optional<Long> getStoreSizeInBytes(String index)

getIndicesStats

public Set<IndexStatistics> getIndicesStats(IndexSet indexSet)

getIndicesStats

public Set<IndexStatistics> getIndicesStats(Collection<String> indices)

cycleAlias

public void cycleAlias(String aliasName,
                       String targetIndex)

cycleAlias

public void cycleAlias(String aliasName,
                       String targetIndex,
                       String oldIndex)

removeAliases

public void removeAliases(String alias,
                          Set<String> indices)

optimizeIndex

public void optimizeIndex(String index,
                          int maxNumSegments,
                          com.github.joschi.jadconfig.util.Duration timeout)

waitForRecovery

public io.searchbox.cluster.Health.Status waitForRecovery(String index)

indexCreationDate

public Optional<org.joda.time.DateTime> indexCreationDate(String index)

indexRangeStatsOfIndex

public IndexRangeStats indexRangeStatsOfIndex(String index)

Calculate min and max message timestamps in the given index.

Parameters:

index - Name of the index to query.

Returns:

the timestamp stats in the given index, or null if they couldn't be calculated.

See Also:

Stats