GitHub user merrimanr opened a pull request:
https://github.com/apache/metron/pull/827
METRON-1294: IP addresses are not formatted correctly in facet and group
results
## Contributor Comments
By default, values in facet and group by results are not formatted
correctly in some cases (IP addresses being one) so the ElasticsearchDao must
correctly format them instead. To do this it must know the type of each
facet/group column to know how to correctly format them. The root cause of
this issue is that the ElasticsearchDao was retrieving "common" column
metadata, or columns that exist in all indices. The addition of the
"metaalert" index broke this because it is missing most of the columns that are
declared in alert indices. This PR corrects this by retrieving all column
metadata across indices so that a missing column in one index does not affect
the results.
The
http://localhost:8080/swagger-ui.html#!/search-controller/getColumnMetadataUsingPOST
changed slightly in that it now just returns a single map with all
columns/types included and no longer segments columns/types by index. This
interface more closely matches how this function is used in the alerts UI and
eliminates the need for the client side code to flatten the result. Column
metadata can still be retrieved for an index by just passing in a single index
to that endpoint. The case of columns existing in multiple indices with
different types is solved by just excluding them from the results.
This can be tested in full dev by executing a search (either with the
Alerts UI or Swagger) and including an ip address field in the facet list. The
results should now include correctly formatted IP addresses in the facetCounts
section of the results. A group query can be verified by including an IP
address in the list of group fields.
I adjusted the SearchControllerIntegrationTest to account for the new
interface and modified cases in the SearchIntegrationTest to catch these issues
in the future.
## Pull Request Checklist
Thank you for submitting a contribution to Apache Metron.
Please refer to our [Development
Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235)
for the complete guide to follow for contributions.
Please refer also to our [Build Verification
Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview)
for complete smoke testing guides.
In order to streamline the review of the contribution we ask you follow
these guidelines and ask you to double check the following:
### For all changes:
- [x] Is there a JIRA ticket associated with this PR? If not one needs to
be created at [Metron
Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
- [x] Does your PR title start with METRON-XXXX where XXXX is the JIRA
number you are trying to resolve? Pay particular attention to the hyphen "-"
character.
- [x] Has your PR been rebased against the latest commit within the target
branch (typically master)?
### For code changes:
- [x] Have you included steps to reproduce the behavior or problem that is
being changed or addressed?
- [x] Have you included steps or a guide to how the change may be verified
and tested manually?
- [x] Have you ensured that the full suite of tests and checks have been
executed in the root metron folder via:
```
mvn -q clean integration-test install && build_utils/verify_licenses.sh
```
- [x] Have you written or updated unit tests and or integration tests to
verify your changes?
- [x] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [x] Have you verified the basic functionality of the build by building
and running locally with Vagrant full-dev environment or the equivalent?
### For documentation related changes:
- [x] Have you ensured that format looks appropriate for the output in
which it is rendered by building and verifying the site-book? If not then run
the following commands and the verify changes via
`site-book/target/site/index.html`:
```
cd site-book
mvn site
```
#### Note:
Please ensure that once the PR is submitted, you check travis-ci for build
issues and submit an update to your PR as soon as possible.
It is also recommended that [travis-ci](https://travis-ci.org) is set up
for your personal repository such that your branches are built there before
submitting a pull request.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/merrimanr/incubator-metron METRON-1294
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/827.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #827
----
commit e2832da037fc0d665821617a95f15481399d4467
Author: merrimanr <merrim...@gmail.com>
Date: 2017-11-03T18:36:23Z
initial commit
----
---
