nifi-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From JPercivall <...@git.apache.org>
Subject [GitHub] nifi pull request #576: NIFI-2068: Add Elasticsearch HTTP processors
Date Wed, 06 Jul 2016 14:51:30 GMT
Github user JPercivall commented on a diff in the pull request:

    https://github.com/apache/nifi/pull/576#discussion_r69745504
  
    --- Diff: nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-processors/src/main/java/org/apache/nifi/processors/elasticsearch/FetchElasticsearchHttp.java
---
    @@ -0,0 +1,312 @@
    +/*
    + * Licensed to the Apache Software Foundation (ASF) under one or more
    + * contributor license agreements.  See the NOTICE file distributed with
    + * this work for additional information regarding copyright ownership.
    + * The ASF licenses this file to You 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.
    + */
    +package org.apache.nifi.processors.elasticsearch;
    +
    +import okhttp3.HttpUrl;
    +import okhttp3.OkHttpClient;
    +import okhttp3.Response;
    +import okhttp3.ResponseBody;
    +import org.apache.commons.lang3.StringUtils;
    +import org.apache.nifi.annotation.behavior.EventDriven;
    +import org.apache.nifi.annotation.behavior.InputRequirement;
    +import org.apache.nifi.annotation.behavior.SupportsBatching;
    +import org.apache.nifi.annotation.behavior.WritesAttribute;
    +import org.apache.nifi.annotation.behavior.WritesAttributes;
    +import org.apache.nifi.annotation.documentation.CapabilityDescription;
    +import org.apache.nifi.annotation.documentation.Tags;
    +import org.apache.nifi.annotation.lifecycle.OnScheduled;
    +import org.apache.nifi.components.PropertyDescriptor;
    +import org.apache.nifi.flowfile.FlowFile;
    +import org.apache.nifi.logging.ComponentLog;
    +import org.apache.nifi.processor.ProcessContext;
    +import org.apache.nifi.processor.ProcessSession;
    +import org.apache.nifi.processor.Relationship;
    +import org.apache.nifi.processor.exception.ProcessException;
    +import org.apache.nifi.processor.util.StandardValidators;
    +import org.apache.nifi.stream.io.ByteArrayInputStream;
    +import org.codehaus.jackson.JsonNode;
    +
    +import java.io.IOException;
    +import java.net.MalformedURLException;
    +import java.net.URL;
    +import java.util.ArrayList;
    +import java.util.Collections;
    +import java.util.HashSet;
    +import java.util.List;
    +import java.util.Set;
    +import java.util.concurrent.TimeUnit;
    +import java.util.stream.Collectors;
    +import java.util.stream.Stream;
    +
    +
    +@InputRequirement(InputRequirement.Requirement.INPUT_ALLOWED)
    +@EventDriven
    +@SupportsBatching
    +@Tags({"elasticsearch", "fetch", "read", "get", "http"})
    +@CapabilityDescription("Retrieves a document from Elasticsearch using the specified connection
properties and the "
    +        + "identifier of the document to retrieve. Note that the full body of the document
will be read into memory before being "
    +        + "written to a Flow File for transfer.")
    +@WritesAttributes({
    +        @WritesAttribute(attribute = "filename", description = "The filename attribute
is set to the document identifier"),
    +        @WritesAttribute(attribute = "es.index", description = "The Elasticsearch index
containing the document"),
    +        @WritesAttribute(attribute = "es.type", description = "The Elasticsearch document
type")
    +})
    +public class FetchElasticsearchHttp extends AbstractElasticsearchHttpProcessor {
    +
    +    private static final String FIELD_INCLUDE_QUERY_PARAM = "_source_include";
    +
    +    public static final Relationship REL_SUCCESS = new Relationship.Builder()
    +            .name("success")
    +            .description("All FlowFiles that are read from Elasticsearch are routed to
this relationship.")
    +            .build();
    +
    +    public static final Relationship REL_FAILURE = new Relationship.Builder()
    +            .name("failure")
    +            .description("All FlowFiles that cannot be read from Elasticsearch are routed
to this relationship. Note that only incoming "
    +                    + "flow files will be routed to failure.")
    +            .build();
    +
    +    public static final Relationship REL_RETRY = new Relationship.Builder().name("retry")
    +            .description("A FlowFile is routed to this relationship if the document cannot
be fetched but attempting the operation again may "
    +                    + "succeed. Note that if the processor has no incoming connections,
flow files may still be sent to this relationship "
    +                    + "based on the processor properties and the results of the fetch
operation.")
    +            .build();
    +
    +    public static final Relationship REL_NOT_FOUND = new Relationship.Builder().name("not
found")
    +            .description("A FlowFile is routed to this relationship if the specified
document does not exist in the Elasticsearch cluster. "
    +                    + "Note that if the processor has no incoming connections, flow files
may still be sent to this relationship based "
    +                    + "on the processor properties and the results of the fetch operation.")
    +            .build();
    +
    +    public static final PropertyDescriptor DOC_ID = new PropertyDescriptor.Builder()
    +            .name("fetch-es-doc-id")
    +            .displayName("Document Identifier")
    +            .description("The identifier of the document to be fetched")
    +            .required(true)
    +            .expressionLanguageSupported(true)
    +            .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
    +            .build();
    +
    +    public static final PropertyDescriptor INDEX = new PropertyDescriptor.Builder()
    +            .name("fetch-es-index")
    +            .displayName("Index")
    +            .description("The name of the index to read from")
    +            .required(true)
    +            .expressionLanguageSupported(true)
    +            .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
    +            .build();
    +
    +    public static final PropertyDescriptor TYPE = new PropertyDescriptor.Builder()
    +            .name("fetch-es-type")
    +            .displayName("Type")
    +            .description("The (optional) type of this document, used by Elasticsearch
for indexing and searching. If the property is empty or set "
    +                    + "to _all, the first document matching the identifier across all
types will be retrieved.")
    +            .required(false)
    +            .expressionLanguageSupported(true)
    +            .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
    +            .build();
    +
    +    public static final PropertyDescriptor FIELDS = new PropertyDescriptor.Builder()
    +            .name("fetch-es-fields")
    +            .displayName("Fields")
    +            .description("A comma-separated list of fields to retrieve from the document.
If the Fields property is left blank, "
    +                    + "then the entire document's source will be retrieved.")
    +            .required(false)
    +            .expressionLanguageSupported(true)
    +            .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
    +            .build();
    +
    +
    +    @Override
    +    public Set<Relationship> getRelationships() {
    +        final Set<Relationship> relationships = new HashSet<>();
    +        relationships.add(REL_SUCCESS);
    +        relationships.add(REL_FAILURE);
    +        relationships.add(REL_RETRY);
    +        relationships.add(REL_NOT_FOUND);
    +        return Collections.unmodifiableSet(relationships);
    +    }
    +
    +    @Override
    +    public final List<PropertyDescriptor> getSupportedPropertyDescriptors() {
    +        final List<PropertyDescriptor> descriptors = new ArrayList<>();
    +        descriptors.add(ES_URL);
    +        descriptors.add(PROP_SSL_CONTEXT_SERVICE);
    +        descriptors.add(USERNAME);
    +        descriptors.add(PASSWORD);
    +        descriptors.add(CONNECT_TIMEOUT);
    +        descriptors.add(RESPONSE_TIMEOUT);
    +        descriptors.add(DOC_ID);
    +        descriptors.add(INDEX);
    +        descriptors.add(TYPE);
    +        descriptors.add(FIELDS);
    +
    +        return Collections.unmodifiableList(descriptors);
    +    }
    +
    +
    +    @OnScheduled
    +    public void setup(ProcessContext context) {
    +        super.setup(context);
    +    }
    +
    +    @Override
    +    public void onTrigger(final ProcessContext context, final ProcessSession session)
throws ProcessException {
    +
    +        FlowFile flowFile = null;
    +        if (context.hasIncomingConnection()) {
    +            flowFile = session.get();
    +
    +            // If we have no FlowFile, and all incoming connections are self-loops then
we can continue on.
    +            // However, if we have no FlowFile and we have connections coming from other
Processors, then
    +            // we know that we should run only if we have a FlowFile.
    +            if (flowFile == null && context.hasNonLoopConnection()) {
    +                return;
    +            }
    +        }
    +
    +        OkHttpClient okHttpClient = getClient();
    +
    +        if (flowFile == null) {
    +            flowFile = session.create();
    +        }
    +
    +        final String index = context.getProperty(INDEX).evaluateAttributeExpressions(flowFile).getValue();
    +        final String docId = context.getProperty(DOC_ID).evaluateAttributeExpressions(flowFile).getValue();
    +        final String docType = context.getProperty(TYPE).evaluateAttributeExpressions(flowFile).getValue();
    +        final String fields = context.getProperty(FIELDS).isSet()
    +                ? context.getProperty(FIELDS).evaluateAttributeExpressions(flowFile).getValue()
    +                : null;
    +
    +        // Authentication
    +        final String username = context.getProperty(USERNAME).getValue();
    +        final String password = context.getProperty(PASSWORD).getValue();
    +
    +        final ComponentLog logger = getLogger();
    +
    +
    +        try {
    +            logger.debug("Fetching {}/{}/{} from Elasticsearch", new Object[]{index,
docType, docId});
    +
    +            // read the url property from the context
    +            final String urlstr = StringUtils.trimToEmpty(context.getProperty(ES_URL).getValue());
    +            final URL url = buildRequestURL(urlstr, docId, index, docType, fields);
    +            final long startNanos = System.nanoTime();
    +
    +            final Response getResponse = sendRequestToElasticsearch(okHttpClient, url,
username, password, "GET", null);
    +            final int statusCode = getResponse.code();
    +
    +            if (isSuccess(statusCode)) {
    +                ResponseBody body = getResponse.body();
    +                final byte[] bodyBytes = body.bytes();
    +                JsonNode responseJson = parseJsonResponse(new ByteArrayInputStream(bodyBytes));
    +                boolean found = responseJson.get("found").asBoolean(false);
    +                String retrievedIndex = responseJson.get("_index").asText();
    +                String retrievedType = responseJson.get("_type").asText();
    +                String retrievedId = responseJson.get("_id").asText();
    +
    +                if (found) {
    +                    JsonNode source = responseJson.get("_source");
    +                    flowFile = session.putAttribute(flowFile, "filename", retrievedId);
    +                    flowFile = session.putAttribute(flowFile, "es.index", retrievedIndex);
    +                    flowFile = session.putAttribute(flowFile, "es.type", retrievedType);
    +                    if (source != null) {
    +                        flowFile = session.write(flowFile, out -> {
    +                            out.write(source.toString().getBytes());
    +                        });
    +                    }
    +                    logger.debug("Elasticsearch document " + retrievedId + " fetched,
routing to success");
    +
    +                    // emit provenance event
    +                    final long millis = TimeUnit.NANOSECONDS.toMillis(System.nanoTime()
- startNanos);
    +                    if (context.hasNonLoopConnection()) {
    +                        session.getProvenanceReporter().fetch(flowFile, url.toExternalForm(),
millis);
    +                    } else {
    +                        session.getProvenanceReporter().receive(flowFile, url.toExternalForm(),
millis);
    +                    }
    +                    session.transfer(flowFile, REL_SUCCESS);
    +                } else {
    +                    logger.warn("Failed to read {}/{}/{} from Elasticsearch: Document
not found",
    +                            new Object[]{index, docType, docId});
    +
    +                    // We couldn't find the document, so send it to "not found"
    +                    session.transfer(flowFile, REL_NOT_FOUND);
    +                }
    +            } else {
    +                if (statusCode == 404) {
    +                    logger.warn("Failed to read {}/{}/{} from Elasticsearch: Document
not found",
    +                            new Object[]{index, docType, docId});
    +
    +                    // We couldn't find the document, so penalize it and send it to "not
found"
    +                    session.transfer(flowFile, REL_NOT_FOUND);
    +                } else {
    +                    // 5xx -> RETRY, but a server error might last a while, so yield
    +                    if (statusCode / 100 == 5) {
    +
    +                        logger.info("Elasticsearch returned code {} with message {},
transferring flow file to retry",
    --- End diff --
    
    Multiple log statements in the same branch (probably best to log WARN)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message