This repository has been archived by the owner on May 12, 2021. It is now read-only.
METRON-1569 Allow user to change field name conversion when indexing … #1022
Closed
Closed
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
c478de1
METRON-1569 Allow user to change field name conversion when indexing …
nickwallen 898c812
Addressed review comments when default converter is created
nickwallen b18c3bf
FieldNameConverters needs to return a new instance on each get(), rat…
nickwallen cee3994
Removed 'caching' factory and replaced with 'shared' factory
nickwallen d79702d
Moved create to FileNameConverters
nickwallen 00f02eb
Added license and small fixups
nickwallen b7363f3
FieldNameConverters is-a FieldNameConverter
nickwallen 30315ee
Don't want an error level log if the user has not defined a converter
nickwallen File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
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
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
46 changes: 46 additions & 0 deletions
46
...m/metron-common/src/main/java/org/apache/metron/common/field/DeDotFieldNameConverter.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,46 @@ | ||
/** | ||
* 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.metron.common.field; | ||
|
||
import org.slf4j.Logger; | ||
import org.slf4j.LoggerFactory; | ||
|
||
import java.io.Serializable; | ||
import java.lang.invoke.MethodHandles; | ||
|
||
/** | ||
* A {@link FieldNameConverter} that replaces all field names containing dots | ||
* with colons. | ||
*/ | ||
public class DeDotFieldNameConverter implements FieldNameConverter, Serializable { | ||
|
||
private static final long serialVersionUID = -3126840090749760299L; | ||
private static final Logger LOG = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); | ||
|
||
@Override | ||
public String convert(String originalField) { | ||
|
||
String newField = originalField.replace(".",":"); | ||
|
||
if(LOG.isDebugEnabled() && originalField.contains(".")) { | ||
LOG.debug("Renamed dotted field; original={}, new={}", originalField, newField); | ||
} | ||
|
||
return newField; | ||
} | ||
} |
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
98 changes: 98 additions & 0 deletions
98
...tform/metron-common/src/main/java/org/apache/metron/common/field/FieldNameConverters.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,98 @@ | ||
/* | ||
* 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.metron.common.field; | ||
|
||
import org.apache.commons.lang.ClassUtils; | ||
import org.apache.commons.lang3.exception.ExceptionUtils; | ||
import org.apache.metron.common.configuration.writer.WriterConfiguration; | ||
import org.slf4j.Logger; | ||
import org.slf4j.LoggerFactory; | ||
|
||
import java.lang.invoke.MethodHandles; | ||
|
||
/** | ||
* Enumerates a set of {@link FieldNameConverter} implementations. | ||
* | ||
* <p>Provides shared instances of each {@link FieldNameConverter}. | ||
* | ||
* <p>Allows the field name converter to be specified using a short-hand | ||
* name, rather than the entire fully-qualified class name. | ||
*/ | ||
public enum FieldNameConverters { | ||
|
||
/** | ||
* A {@link FieldNameConverter} that does not rename any fields. All field | ||
* names remain unchanged. | ||
*/ | ||
NOOP(new NoopFieldNameConverter()), | ||
|
||
/** | ||
* A {@link FieldNameConverter} that replaces all field names containing dots | ||
* with colons. | ||
*/ | ||
DEDOT(new DeDotFieldNameConverter()); | ||
|
||
private static final Logger LOG = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); | ||
|
||
private FieldNameConverter converter; | ||
|
||
FieldNameConverters(FieldNameConverter converter) { | ||
this.converter = converter; | ||
} | ||
|
||
/** | ||
* Returns a shared instance of the {@link FieldNameConverter}/ | ||
* | ||
* @return A shared {@link FieldNameConverter} instance. | ||
*/ | ||
public FieldNameConverter get() { | ||
return converter; | ||
} | ||
|
||
/** | ||
* Create a new {@link FieldNameConverter}. | ||
* | ||
* @param sensorType The type of sensor. | ||
* @param config The writer configuration. | ||
* @return | ||
*/ | ||
public static FieldNameConverter create(String sensorType, WriterConfiguration config) { | ||
|
||
// which field name converter should be used? | ||
String converterName = config.getFieldNameConverter(sensorType); | ||
FieldNameConverter result = null; | ||
try { | ||
result = FieldNameConverters.valueOf(converterName).get(); | ||
|
||
} catch(IllegalArgumentException e) { | ||
LOG.error("Invalid field name converter, using default; configured={}, knownValues={}, error={}", | ||
converterName, FieldNameConverters.values(), ExceptionUtils.getRootCauseMessage(e)); | ||
} | ||
|
||
if(result == null) { | ||
// default to the 'DEDOT' field name converter to maintain backwards compatibility | ||
result = FieldNameConverters.DEDOT.get(); | ||
} | ||
|
||
LOG.debug("Created field name converter; sensorType={}, configured={}, class={}", | ||
sensorType, converterName, ClassUtils.getShortClassName(result, "null")); | ||
|
||
return result; | ||
} | ||
} |
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor nit, can we have this implement
FieldNameConverter
so the enum can be used directly without callingget()
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok. Check 'er out.