-
Notifications
You must be signed in to change notification settings - Fork 25.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ingest: Introduce the dissect processor (#32884)
* ingest: Introduce the dissect processor The ingest node dissect processor is an alternative to Grok to split a string based on a pattern. Dissect differs from Grok such that regular expressions are not used to split the string. Dissect can be used to parse a source text field with a simpler pattern, and is often faster the Grok for basic string parsing. This processor uses the dissect library which does most of the work.
- Loading branch information
1 parent
d7e4a49
commit 79b507d
Showing
7 changed files
with
567 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
76 changes: 76 additions & 0 deletions
76
modules/ingest-common/src/main/java/org/elasticsearch/ingest/common/DissectProcessor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch 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.elasticsearch.ingest.common; | ||
|
|
||
| import org.elasticsearch.dissect.DissectParser; | ||
| import org.elasticsearch.ingest.AbstractProcessor; | ||
| import org.elasticsearch.ingest.ConfigurationUtils; | ||
| import org.elasticsearch.ingest.IngestDocument; | ||
| import org.elasticsearch.ingest.Processor; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| public final class DissectProcessor extends AbstractProcessor { | ||
|
|
||
| public static final String TYPE = "dissect"; | ||
| //package private members for testing | ||
| final String field; | ||
| final boolean ignoreMissing; | ||
| final String pattern; | ||
| final String appendSeparator; | ||
| final DissectParser dissectParser; | ||
|
|
||
| DissectProcessor(String tag, String field, String pattern, String appendSeparator, boolean ignoreMissing) { | ||
| super(tag); | ||
| this.field = field; | ||
| this.ignoreMissing = ignoreMissing; | ||
| this.pattern = pattern; | ||
| this.appendSeparator = appendSeparator; | ||
| this.dissectParser = new DissectParser(pattern, appendSeparator); | ||
| } | ||
|
|
||
| @Override | ||
| public void execute(IngestDocument ingestDocument) { | ||
| String input = ingestDocument.getFieldValue(field, String.class, ignoreMissing); | ||
| if (input == null && ignoreMissing) { | ||
| return; | ||
| } else if (input == null) { | ||
| throw new IllegalArgumentException("field [" + field + "] is null, cannot process it."); | ||
| } | ||
| dissectParser.parse(input).forEach(ingestDocument::setFieldValue); | ||
| } | ||
|
|
||
| @Override | ||
| public String getType() { | ||
| return TYPE; | ||
| } | ||
|
|
||
| public static final class Factory implements Processor.Factory { | ||
|
|
||
| @Override | ||
| public DissectProcessor create(Map<String, Processor.Factory> registry, String processorTag, Map<String, Object> config) { | ||
| String field = ConfigurationUtils.readStringProperty(TYPE, processorTag, config, "field"); | ||
| String pattern = ConfigurationUtils.readStringProperty(TYPE, processorTag, config, "pattern"); | ||
| String appendSeparator = ConfigurationUtils.readStringProperty(TYPE, processorTag, config, "append_separator", ""); | ||
| boolean ignoreMissing = ConfigurationUtils.readBooleanProperty(TYPE, processorTag, config, "ignore_missing", false); | ||
| return new DissectProcessor(processorTag, field, pattern, appendSeparator, ignoreMissing); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
92 changes: 92 additions & 0 deletions
92
...st-common/src/test/java/org/elasticsearch/ingest/common/DissectProcessorFactoryTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch 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.elasticsearch.ingest.common; | ||
|
|
||
| import org.elasticsearch.ElasticsearchParseException; | ||
| import org.elasticsearch.dissect.DissectException; | ||
| import org.elasticsearch.ingest.RandomDocumentPicks; | ||
| import org.elasticsearch.test.ESTestCase; | ||
| import org.hamcrest.Matchers; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| import static org.hamcrest.CoreMatchers.equalTo; | ||
| import static org.hamcrest.CoreMatchers.notNullValue; | ||
| import static org.hamcrest.Matchers.is; | ||
|
|
||
| public class DissectProcessorFactoryTests extends ESTestCase { | ||
|
|
||
| public void testCreate() { | ||
| DissectProcessor.Factory factory = new DissectProcessor.Factory(); | ||
| String fieldName = RandomDocumentPicks.randomFieldName(random()); | ||
| String processorTag = randomAlphaOfLength(10); | ||
| String pattern = "%{a},%{b},%{c}"; | ||
| String appendSeparator = ":"; | ||
|
|
||
| Map<String, Object> config = new HashMap<>(); | ||
| config.put("field", fieldName); | ||
| config.put("pattern", pattern); | ||
| config.put("append_separator", appendSeparator); | ||
| config.put("ignore_missing", true); | ||
|
|
||
| DissectProcessor processor = factory.create(null, processorTag, config); | ||
| assertThat(processor.getTag(), equalTo(processorTag)); | ||
| assertThat(processor.field, equalTo(fieldName)); | ||
| assertThat(processor.pattern, equalTo(pattern)); | ||
| assertThat(processor.appendSeparator, equalTo(appendSeparator)); | ||
| assertThat(processor.dissectParser, is(notNullValue())); | ||
| assertThat(processor.ignoreMissing, is(true)); | ||
| } | ||
|
|
||
| public void testCreateMissingField() { | ||
| DissectProcessor.Factory factory = new DissectProcessor.Factory(); | ||
| Map<String, Object> config = new HashMap<>(); | ||
| config.put("pattern", "%{a},%{b},%{c}"); | ||
| Exception e = expectThrows(ElasticsearchParseException.class, () -> factory.create(null, "_tag", config)); | ||
| assertThat(e.getMessage(), Matchers.equalTo("[field] required property is missing")); | ||
| } | ||
|
|
||
| public void testCreateMissingPattern() { | ||
| DissectProcessor.Factory factory = new DissectProcessor.Factory(); | ||
| Map<String, Object> config = new HashMap<>(); | ||
| config.put("field", randomAlphaOfLength(10)); | ||
| Exception e = expectThrows(ElasticsearchParseException.class, () -> factory.create(null, "_tag", config)); | ||
| assertThat(e.getMessage(), Matchers.equalTo("[pattern] required property is missing")); | ||
| } | ||
|
|
||
| public void testCreateMissingOptionals() { | ||
| DissectProcessor.Factory factory = new DissectProcessor.Factory(); | ||
| Map<String, Object> config = new HashMap<>(); | ||
| config.put("pattern", "%{a},%{b},%{c}"); | ||
| config.put("field", randomAlphaOfLength(10)); | ||
| DissectProcessor processor = factory.create(null, "_tag", config); | ||
| assertThat(processor.appendSeparator, equalTo("")); | ||
| assertThat(processor.ignoreMissing, is(false)); | ||
| } | ||
|
|
||
| public void testCreateBadPattern() { | ||
| DissectProcessor.Factory factory = new DissectProcessor.Factory(); | ||
| Map<String, Object> config = new HashMap<>(); | ||
| config.put("pattern", "no keys defined"); | ||
| config.put("field", randomAlphaOfLength(10)); | ||
| expectThrows(DissectException.class, () -> factory.create(null, "_tag", config)); | ||
| } | ||
| } |
Oops, something went wrong.