AaronLeon commented on a change in pull request #2861: NIFI-5248 Added new Elasticsearch json and record processors. URL: https://github.com/apache/nifi/pull/2861#discussion_r284761077
########## File path: nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-restapi-processors/src/main/java/org/apache/nifi/processors/elasticsearch/PutElasticsearchJson.java ########## @@ -0,0 +1,366 @@ +/* + * 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 com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.jayway.jsonpath.DocumentContext; +import com.jayway.jsonpath.JsonPath; +import org.apache.nifi.annotation.behavior.InputRequirement; +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.components.ValidationContext; +import org.apache.nifi.components.ValidationResult; +import org.apache.nifi.components.Validator; +import org.apache.nifi.elasticsearch.ElasticSearchClientService; +import org.apache.nifi.elasticsearch.ElasticSearchError; +import org.apache.nifi.elasticsearch.IndexOperationRequest; +import org.apache.nifi.expression.ExpressionLanguageScope; +import org.apache.nifi.flowfile.FlowFile; +import org.apache.nifi.processor.AbstractProcessor; +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.processors.elasticsearch.put.FlowFileJsonDescription; +import org.apache.nifi.processors.elasticsearch.put.JsonProcessingError; +import org.apache.nifi.util.StringUtils; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.stream.Collectors; + +@InputRequirement(InputRequirement.Requirement.INPUT_REQUIRED) +@Tags({"json", "elasticsearch", "elasticsearch5", "elasticsearch6", "put", "index"}) +@CapabilityDescription("This processor puts user-supplied JSON into ElasticSearch. It does not require a schema.") +public class PutElasticsearchJson extends AbstractProcessor implements ElasticSearchRestProcessor { + + static final PropertyDescriptor ID_ATTRIBUTE = new PropertyDescriptor.Builder() + .name("put-es-json-id-attribute") + .displayName("ID Attribute") + .description("The attribute to use for setting the document ID in ElasticSearch. If the payload is an array, " + + "and this option is used for getting the ID, an exception will be raised.") + .required(false) + .expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES) + .addValidator(Validator.VALID) + .build(); + static final PropertyDescriptor ID_JSON_PATH = new PropertyDescriptor.Builder() + .name("put-es-json-id-json-path") + .displayName("ID JSONPath") + .description("If set, the document ID will be pulled from each JSON block using this JSONPath operation.") + .required(false) + .expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES) + .addValidator(Validator.VALID) + .build(); + static final PropertyDescriptor INDEX_JSON_PATH = new PropertyDescriptor.Builder() + .name("put-es-json-index-json-path") + .displayName("Index JSONPath") + .description("If set, the document's target index will be pulled from each JSON block using this JSONPath operation. " + + "If it is left blank or fails to evaluate to a valid value, the index property's valuable will be used instead. ") + .required(false) + .expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES) + .addValidator(Validator.VALID) + .build(); + static final PropertyDescriptor TYPE_JSON_PATH = new PropertyDescriptor.Builder() + .name("put-es-json-type-json-path") + .displayName("Type JSONPath") + .description("If set, the document's target type will be pulled from each JSON block using this JSONPath operation. " + + "If it is left blank or fails to evaluate to a valid value, the type property's valuable will be used instead. ") + .required(false) + .expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES) + .addValidator(Validator.VALID) + .build(); + static final PropertyDescriptor BATCH_SIZE = new PropertyDescriptor.Builder() + .name("put-es-json-batch-size") + .displayName("Batch Size") + .description("The number of flowfiles to fetch per batch. Be very careful about setting this value high if" + + "JSON arrays could be sent in the flowfiles.") + .required(true) + .defaultValue("50") + .expressionLanguageSupported(ExpressionLanguageScope.VARIABLE_REGISTRY) + .addValidator(StandardValidators.POSITIVE_INTEGER_VALIDATOR) + .build(); + + private ObjectMapper mapper = new ObjectMapper(); + private ElasticSearchClientService clientService; + + @Override + public Set<Relationship> getRelationships() { + return new HashSet<Relationship>(){{ + add(REL_SUCCESS); + add(REL_FAILURE); + add(REL_RETRY); + }}; + } + + @Override + public final List<PropertyDescriptor> getSupportedPropertyDescriptors() { + PropertyDescriptor _INDEX = new PropertyDescriptor.Builder() + .fromPropertyDescriptor(INDEX) + .description(INDEX.getDescription() + " Cannot be set at the same time as the Index JSON Path property.") + .build(); + PropertyDescriptor _TYPE = new PropertyDescriptor.Builder() + .fromPropertyDescriptor(TYPE) + .description(TYPE.getDescription() + " Cannot be set at the same time as the Type JSON Path property.") + .build(); + + List<PropertyDescriptor> _temp = new ArrayList<>(); + _temp.add(_INDEX); + _temp.add(_TYPE); + _temp.add(CLIENT_SERVICE); + _temp.add(ID_ATTRIBUTE); + _temp.add(ID_JSON_PATH); + _temp.add(INDEX_JSON_PATH); + _temp.add(TYPE_JSON_PATH); + _temp.add(BATCH_SIZE); + + return Collections.unmodifiableList(_temp); + } + + @Override + protected Collection<ValidationResult> customValidate(ValidationContext validationContext) { + List<ValidationResult> retVal = new ArrayList<>(); + boolean attrIsSet = validationContext.getProperty(ID_ATTRIBUTE).isSet(); + boolean jpIsSet = validationContext.getProperty(ID_JSON_PATH).isSet(); + + if (attrIsSet && jpIsSet) { + retVal.add( + new ValidationResult.Builder() + .valid(false) + .explanation("The ID attribute configuration and JSONPath configuration cannot be set at the same time.") + .build() + ); + } + + boolean idxAttrIsSet = validationContext.getProperty(INDEX).isSet(); + boolean idxJpIsSet = validationContext.getProperty(INDEX_JSON_PATH).isSet(); + + if (!idxAttrIsSet && !idxJpIsSet) { + retVal.add( + new ValidationResult.Builder() + .valid(false) + .explanation("Either the index attribute or index JSON Path fields must be set.") + .build() + ); + } + + boolean typeAttrIsSet = validationContext.getProperty(TYPE).isSet(); + boolean typeJpIsSet = validationContext.getProperty(TYPE_JSON_PATH).isSet(); + + if (!typeAttrIsSet && !typeJpIsSet) { + retVal.add( + new ValidationResult.Builder() + .valid(false) + .explanation("Either the type attribute or type JSON Path fields must be set.") + .build() + ); + } + + return retVal; + } + + private IDStrategy idStrategy; + private int batchSize; + private boolean ijpIsSet; + private boolean tjpIsSet; + + @OnScheduled + public void onScheduled(ProcessContext context) { + boolean attrIsSet = context.getProperty(ID_ATTRIBUTE).isSet(); + boolean jpIsSet = context.getProperty(ID_JSON_PATH).isSet(); + + ijpIsSet = context.getProperty(INDEX_JSON_PATH).isSet(); + tjpIsSet = context.getProperty(TYPE_JSON_PATH).isSet(); + + if (attrIsSet) { + idStrategy = IDStrategy.Attribute; + } else if (jpIsSet) { + idStrategy = IDStrategy.JSONPath; + + } else { + idStrategy = IDStrategy.Generate; + } + + batchSize = context.getProperty(BATCH_SIZE).evaluateAttributeExpressions().asInteger(); + clientService = context.getProperty(CLIENT_SERVICE).asControllerService(ElasticSearchClientService.class); + } + + @Override + public void onTrigger(ProcessContext context, ProcessSession session) throws ProcessException { + List<FlowFile> flowFiles = session.get(batchSize); + if (flowFiles.size() == 0) { + return; + } + + try { + List<FlowFileJsonDescription> jsonStrings = getJsonStringsFromFlowFiles(flowFiles, context, session); + List<IndexOperationRequest> operations = buildIndexOperations(jsonStrings); + + clientService.bulk(operations); + + session.transfer(flowFiles, REL_SUCCESS); + } catch (ElasticSearchError ese) { + String msg = String.format("Encountered a server-side problem with ElasticSearch. %s", + ese.isElastic() ? "Moving to retry." : "Moving to failure"); + getLogger().error(msg, ese); + Relationship rel = ese.isElastic() ? REL_RETRY : REL_FAILURE; + session.transfer(flowFiles, rel); + } catch (Exception ex) { + getLogger().error("Error during indexing...", ex); + session.transfer(flowFiles, REL_FAILURE); + } + } + + private List<FlowFileJsonDescription> getJsonStringsFromFlowFiles(List<FlowFile> flowFiles, ProcessContext context, ProcessSession session) throws IOException, JsonProcessingError { + List<FlowFileJsonDescription> retVal = new ArrayList<>(); + for (int index = 0; index < flowFiles.size(); index++) { + final FlowFile ff = flowFiles.get(index); + ByteArrayOutputStream out = new ByteArrayOutputStream(); + session.exportTo(ff, out); + out.close(); + + String json = new String(out.toByteArray()).trim(); + + if (idStrategy == IDStrategy.Attribute && json.startsWith("[")) { + throw new JsonProcessingError("You cannot use the attribute ID strategy on an array of JSON items."); + } + + String targetIndex = context.getProperty(INDEX).evaluateAttributeExpressions(ff).getValue(); + String targetType = context.getProperty(TYPE).isSet() + ? context.getProperty(TYPE).evaluateAttributeExpressions(ff).getValue() + : null; + + String id = context.getProperty(ID_ATTRIBUTE).isSet() + ? context.getProperty(ID_ATTRIBUTE).evaluateAttributeExpressions(flowFiles.get(index)).getValue() Review comment: I think just considering the context of other Elasticsearch processors, users may be misled. Take PutElasticsearchHttp for example, ID_ATTRIBUTE refers to the name of an attribute which is then used to retrieve an attribute from the FF. Here, ID_ATTRIBUTE is used as a literal value supporting expression language. https://github.com/apache/nifi/blob/master/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-processors/src/main/java/org/apache/nifi/processors/elasticsearch/PutElasticsearchHttp.java#L278 ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
