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: 6.0.1
/**
 * 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 javax.inject.Singleton;
import java.io.Serializable;
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.
 */
@Singleton
public class IndexMapping {
    public static final String TYPE_MESSAGE = "message";

    public Map messageTemplate(final String template, final String analyzer) {
        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,
                "settings", settings,
                "mappings", mappings
        );
    }

    public Map messageMapping(final String analyzer) {
        return ImmutableMap.of(
                "properties", partFieldProperties(analyzer),
                "dynamic_templates", partDefaultAllInDynamicTemplate(),
                "_source", enabled());
    }

    /*
     * Disable analyzing for every field by default.
     */
    private List>> partDefaultAllInDynamicTemplate() {
        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);
    }

    /*
     * Enable analyzing for some fields again. Like for message and full_message.
     */
    private Map> partFieldProperties(String analyzer) {
        return ImmutableMap.of(
                "message", analyzedString(analyzer),
                "full_message", analyzedString(analyzer),
                // http://joda-time.sourceforge.net/api-release/org/joda/time/format/DateTimeFormat.html
                // http://www.elasticsearch.org/guide/reference/mapping/date-format.html
                "timestamp", typeTimeWithMillis(),
                // to support wildcard searches in source we need to lowercase the content (wildcard search lowercases search term)
                "source", analyzedString("analyzer_keyword"),
                "streams", notAnalyzedString());
    }

    private Map notAnalyzedString() {
        return ImmutableMap.of(
                "index", "not_analyzed",
                "type", "string");
    }

    private Map analyzedString(String analyzer) {
        return ImmutableMap.of(
                "index", "analyzed",
                "type", "string",
                "analyzer", analyzer);
    }

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

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