ruffle1986 opened a new pull request #1360: METRON-1856: Parser aggregation
URL: https://github.com/apache/metron/pull/1360
 
 
   ## Contributor Comments
   
   Link to the original ASF Jira ticket: 
https://issues.apache.org/jira/browse/METRON-1856
   
   ## About the feature
   
   The use is able to group individual sensors together. The purpose of it is 
being able to start/stop or enable/disable sensors of the same kind. It's for 
the sake of convenience. 
   
   ## How?
   
   Go to a sensor list screen and simply grab a sensor and drop it on another. 
There's a grid icon that indicates the fact that the row is draggable. Grab the 
grid and move it around. By doing to this, you can aggregate two sensors. After 
that, a pane appears where you can add the name of the two groups. You can also 
add a description as a reminder about what's going on. 
   
   Then you'll the newly created group and the two aggregated sensors below. 
The purple rectangles next to the group name are for pointing out that they're 
groups obviously. The sensors that belong to a particular group are listed 
below. There's a dash at the beginning of the row to show the connection 
between the group and the sensors.
   
   Once sensors are grouped together you're unable to perform operations on 
them individually. You can only perform operations on the group. 
   
   Once a group is created, you can add as many sensors to it as you want. 
   
   You can only add sensors to stopped or disabled groups.
   
   You can only aggregate stopped or disabled sensors together.
   
   If a sensor belongs to a group, you can remove it by dragging and moving it 
out from the group's area.
   
   You can edit the group name and the description anytime by clicking on the 
pen icon on the right.
   
   It could be hard to notice but it's possible to put a sensor between two 
already grouped sensors inside a group. There's a blue line between rows to 
make it obvious.
   
   It's very important to point it out that the result of the aggregation is 
not immediately persisted on the backend. You have to click on the "APPLY" 
button at the bottom of the screen.
   
   Different colors for each row mean different updates:
   
   - Red: Group or sensor is deleted
   - Yellow: Group or sensor has been changed
   - Green: New item in the list
   
   Once the changes are persisted after hitting the Apply button, the colors 
disappear.
   
   You can undo all of your updates since the latest save by clicking on the 
"DISCARD ALL" button next to the APPLY button.
   
   ## Important Blocker
   
   This PR cannot be merged back to master until @merrimanr is done with the 
related updates of the backend part of the parser aggregation feature. Until 
then, I close this PR and reopen it once he's done.
   
   ## Testing
   
   - Go to the`metron-alerts` folder
   - Run `npm ci`
   - Run the development environment as you would normally do
   - Go to `http://localhost:4200/sensors` in your browser
   - Play with the new features described above
   
   ## 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 && 
dev-utilities/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.
   

----------------------------------------------------------------
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:
[email protected]


With regards,
Apache Git Services

Reply via email to