org.graylog2.indexer.IndexSet Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 5.2.7
/**
 * This file is part of Graylog.
 *
 * Graylog is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Graylog is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Graylog.  If not, see .
 */
package org.graylog2.indexer;

import com.google.common.collect.ComparisonChain;
import org.graylog2.indexer.indexset.IndexSetConfig;
import org.graylog2.indexer.indices.TooManyAliasesException;

import javax.annotation.Nullable;
import java.util.Comparator;
import java.util.Map;
import java.util.Optional;
import java.util.Set;

import static java.util.Objects.requireNonNull;

public interface IndexSet extends Comparable {
    /**
     * Returns an array with all managed indices in this index set.
     * 
     * Example: {@code ["graylog_0", "graylog_1", "graylog_2"]}
     *
     * @return array of index names
     */
    String[] getManagedIndices();

    /**
     * Returns the write index alias name for this index set.
     * 

     * The write index alias always points to the newest index.
     * 

     * Example: {@code "graylog_deflector"}
     *
     * @return the write index alias name
     */
    String getWriteIndexAlias();

    /**
     * Returns the index wildcard for this index set.
     * 

     * This can be used in Elasticsearch queries to match all managed indices in this index set.
     * 

     * Example: {@code "graylog_*"}
     *
     * @return the index wildcard
     */
    String getIndexWildcard();

    /**
     * Returns the newest index.
     * 

     * Example: {@code "graylog_42"}
     *
     * @return the newest index
     * @throws NoTargetIndexException if there are no indices in this index set yet
     */
    String getNewestIndex() throws NoTargetIndexException;

    /**
     * Returns the active write index.
     * 

     * Incoming messages for this index set will be written into this index.
     * 

     * Example: {@code "graylog_42"}
     *
     * @return the active write index
     * @throws TooManyAliasesException if the write index alias points to more than one index
     */
    @Nullable
    String getActiveWriteIndex() throws TooManyAliasesException;

    /**
     * Returns a map where the key is an index name and the value a set of aliases for this index.
     * 

     * Only the active write index should have an alias, the other values should be empty.
     * 

     * Example: {@code {graylog_0=[], graylog_1=[], graylog_2=[graylog_deflector}}
     *
     * @return map of index names to index aliases
     */
    Map> getAllIndexAliases();

    /**
     * Returns the index prefix for this index set.
     * 

     * Example: {@code "graylog"}
     *
     * @return index prefix for this index set
     */
    String getIndexPrefix();

    /**
     * Checks if the write index alias exists.
     *
     * @return true if the write index alias exists, false if not
     */
    boolean isUp();

    /**
     * Checks if the given index name is equals to the write index alias.
     *
     * @param index index name to check
     * @return true if given index name is the write index alias, false if not
     */
    boolean isWriteIndexAlias(String index);

    /**
     * Checks if the given index name is part of this index set.
     *
     * @param index index name to check
     * @return true if part of index set, false if not
     */
    boolean isManagedIndex(String index);

    /**
     * Prepares this index set to receive new messages.
     */
    void setUp();

    /**
     * Creates a new index and points the write index alias to it.
     */
    void cycle();

    /**
     * This ensures that the write index alias only points to the newest index.
     * 

     * Can be used to fix the aliases in this index set when a {@link TooManyAliasesException} has been thrown.
     *
     * @param indices list of indices where the index alias points to
     */
    void cleanupAliases(Set indices);

    /**
     * Changes the write index alias from the old index to the new one.
     *
     * @param newIndexName index to add the write index alias to
     * @param oldIndexName index to remove the write index alias from
     */
    void pointTo(String newIndexName, String oldIndexName);

    /**
     * Extracts the index number from an index name.
     * 
     * Example: {@code "graylog_42" => 42}
     *
     * @param index index name
     * @return a filled {@link Optional} with the extracted index number, an empty one if the number couldn't be parsed
     */
    Optional extractIndexNumber(String index);

    /**
     * The configuration for this index set.
     *
     * @return index set configuration object
     */
    IndexSetConfig getConfig();

    class IndexNameComparator implements Comparator {
        private final IndexSet indexSet;

        IndexNameComparator(IndexSet indexSet) {
            this.indexSet = requireNonNull(indexSet);
        }

        @Override
        public int compare(String o1, String o2) {
            final int indexNumber1 = indexSet.extractIndexNumber(o1).orElse(-1);
            final int indexNumber2 = indexSet.extractIndexNumber(o2).orElse(-1);
            return ComparisonChain.start()
                    .compare(indexNumber1, indexNumber2)
                    .result();
        }
    }
}