org.graylog2.indexer.IndexMapping 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.ImmutableList;
import com.google.common.collect.ImmutableMap;
import org.graylog2.plugin.Tools;

import java.util.List;
import java.util.Map;

/**
 * Representing the message type mapping in Elasticsearch. This is giving ES more
 * information about what the fields look like and how it should analyze them.
 */
public abstract class IndexMapping {
    public static final String TYPE_MESSAGE = "message";

    public Map messageTemplate(final String template, final String analyzer) {
        return messageTemplate(template, analyzer, -1);
    }

    public Map messageTemplate(final String template, final String analyzer, final int order) {
        final Map analyzerKeyword = ImmutableMap.of("analyzer_keyword", ImmutableMap.of(
                "tokenizer", "keyword",
                "filter", "lowercase"));
        final Map analysis = ImmutableMap.of("analyzer", analyzerKeyword);
        final Map settings = ImmutableMap.of("analysis", analysis);
        final Map mappings = ImmutableMap.of(TYPE_MESSAGE, messageMapping(analyzer));

        return ImmutableMap.of(
                "template", template,
                "order", order,
                "settings", settings,
                "mappings", mappings
        );
    }

    protected Map messageMapping(final String analyzer) {
        return ImmutableMap.of(
                "properties", fieldProperties(analyzer),
                "dynamic_templates", dynamicTemplate(),
                "_source", enabled());
    }

    protected List>> dynamicTemplate() {
        final Map defaultInternal = ImmutableMap.of(
                "match", "gl2_*",
                "mapping", notAnalyzedString());
        final Map> templateInternal = ImmutableMap.of("internal_fields", defaultInternal);

        final Map defaultAll = ImmutableMap.of(
                // Match all
                "match", "*",
                // Analyze nothing by default
                "mapping", ImmutableMap.of("index", "not_analyzed"));
        final Map> templateAll = ImmutableMap.of("store_generic", defaultAll);

        return ImmutableList.of(templateInternal, templateAll);
    }

    protected abstract Map> fieldProperties(String analyzer);

    protected abstract Map notAnalyzedString();

    protected Map typeTimeWithMillis() {
        return ImmutableMap.of(
                "type", "date",
                "format", Tools.ES_DATE_FORMAT);
    }

    protected Map enabled() {
        return ImmutableMap.of("enabled", true);
    }
}