All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.appenders.log4j2.elasticsearch.ahc.ElasticsearchBulkPlugin Maven / Gradle / Ivy

Go to download

Log4j2 Appender plugin pushing logs in batches to Elasticsearch (2.x/5.x/6.x/7.x/8.x) clusters

The newest version!
package org.appenders.log4j2.elasticsearch.ahc;

/*-
 * #%L
 * log4j2-elasticsearch
 * %%
 * Copyright (C) 2022 Rafal Foltynski
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import com.fasterxml.jackson.databind.ObjectReader;
import com.fasterxml.jackson.databind.ObjectWriter;
import org.apache.logging.log4j.core.config.ConfigurationException;
import org.apache.logging.log4j.core.config.Node;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
import org.appenders.log4j2.elasticsearch.Deserializer;
import org.appenders.log4j2.elasticsearch.JacksonDeserializer;
import org.appenders.log4j2.elasticsearch.JacksonSerializer;
import org.appenders.log4j2.elasticsearch.Serializer;

@Plugin(name = "ElasticsearchBulk", category = Node.CATEGORY, elementType = "clientAPIFactory", printObject = true)
public class ElasticsearchBulkPlugin extends ElasticsearchBulkAPI {

    private ElasticsearchBulkPlugin(
            final Serializer itemSerializer,
            final Deserializer resultDeserializer,
            final String mappingType,
            final String filterPath) {
        super(mappingType, filterPath, itemSerializer, resultDeserializer);
    }

    @PluginBuilderFactory
    public static Builder newBuilder() {
        return new Builder();
    }

    public static class Builder implements org.apache.logging.log4j.core.util.Builder {

        @PluginAttribute(value = "mappingType")
        protected String mappingType;

        @PluginAttribute(value = "filterPath")
        protected String filterPath;

        private Serializer itemSerializer = createItemSerializer();
        private Deserializer resultDeserializer = createResultDeserializer();

        @Override
        public ElasticsearchBulkPlugin build()
        {
            if (itemSerializer == null) {
                throw new ConfigurationException("itemSerializer cannot be null");
            }

            if (resultDeserializer == null) {
                throw new ConfigurationException("resultDeserializer cannot be null");
            }

            return new ElasticsearchBulkPlugin(itemSerializer, resultDeserializer, mappingType, filterPath);
        }

        public Builder withMappingType(final String mappingType) {
            this.mappingType = mappingType;
            return this;
        }

        public Builder withFilterPath(final String filterPath) {
            this.filterPath = filterPath;
            return this;
        }

        public Builder withItemSerializer(final Serializer itemSerializer) {
            this.itemSerializer = itemSerializer;
            return this;
        }

        public Builder withResultDeserializer(final Deserializer resultDeserializer) {
            this.resultDeserializer = resultDeserializer;
            return this;
        }

        /**
         * @return index request metadata serializer
         */
        protected Serializer createItemSerializer() {
            final ObjectWriter objectWriter = ElasticsearchBulkAPI.defaultObjectMapper()
                    .writerFor(IndexRequest.class);
            return new JacksonSerializer<>(objectWriter);
        }

        /**
         * @return batch response deserializer
         */
        @SuppressWarnings("DuplicatedCode")
        protected Deserializer createResultDeserializer() {

            final ObjectReader objectReader = ElasticsearchBulkAPI.defaultObjectMapper()
                    .readerFor(BatchResult.class);

            return new JacksonDeserializer<>(objectReader);

        }

    }

}