METRON-2267: Audit Zookeeper config changes in REST

[merrimanr]

Contributor Comments

This PR adds logging for changes to Zookeeper configs (including user).

Testing

This has been tested in full dev.

1. Spin up full dev and change the Metron REST logging level to INFO as described here.

2. Navigate to Swagger and makes changes to parser, enrichment and indexing configurations (including delete). Log statements should reflect the changes made. For example, this request:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{
  "parserClassName": "org.apache.metron.parsers.bro.BasicBroParser",
  "filterClassName": null,
  "sensorTopic": "bro",
  "outputTopic": null,
  "errorTopic": null,
  "writerClassName": null,
  "errorWriterClassName": null,
  "readMetadata": false,
  "mergeMetadata": false,
  "numWorkers": null,
  "numAckers": null,
  "spoutParallelism": 1,
  "spoutNumTasks": 1,
  "parserParallelism": 1,
  "parserNumTasks": 1,
  "errorWriterParallelism": 1,
  "errorWriterNumTasks": 1,
  "spoutConfig": {},
  "securityProtocol": null,
  "stormConfig": {},
  "parserConfig": {
    "test": "value"
  },
  "fieldTransformations": [],
  "cacheConfig": {},
  "rawMessageStrategy": "DEFAULT",
  "rawMessageStrategyConfig": {}
}' 'http://user:password@node1:8082/api/v1/sensor/parser/config/bro'

Should cause this message to be logged in /var/log/metron/metron-rest.log:

2019-09-25 05:25:17.017  INFO 13505 --- [nio-8082-exec-1] o.a.m.r.c.SensorParserConfigController   : User 'user' changed the 'bro' parser config to org.apache.metron.common.configuration.SensorParserConfig@502e087f[parserClassName=org.apache.metron.parsers.bro.BasicBroParser,filterClassName=<null>,sensorTopic=bro,outputTopic=<null>,errorTopic=<null>,writerClassName=<null>,errorWriterClassName=<null>,readMetadata=false,mergeMetadata=false,numWorkers=<null>,numAckers=<null>,spoutParallelism=1,spoutNumTasks=1,parserParallelism=1,parserNumTasks=1,errorWriterParallelism=1,errorWriterNumTasks=1,spoutConfig={},securityProtocol=<null>,stormConfig={},cacheConfig={},parserConfig={test=value},fieldTransformations=[],rawMessageStrategy=DEFAULT,rawMessageStrategyConfig={}]

Pull Request Checklist

Thank you for submitting a contribution to Apache Metron.
Please refer to our Development Guidelines for the complete guide to follow for contributions.
Please refer also to our Build Verification Guidelines 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:

• Is there a JIRA ticket associated with this PR? If not one needs to be created at Metron Jira.
• 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.
• Has your PR been rebased against the latest commit within the target branch (typically master)?

For code changes:

• Have you included steps to reproduce the behavior or problem that is being changed or addressed?

• Have you included steps or a guide to how the change may be verified and tested manually?

• 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 
  

• Have you written or updated unit tests and or integration tests to verify your changes?

• If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?

• 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:

• 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
  

• Have you ensured that any documentation diagrams have been updated, along with their source files, using draw.io? See Metron Development Guidelines for instructions.

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 is set up for your personal repository such that your branches are built there before submitting a pull request.

[mmiklavc]

We should be using slf4j tokenization instead of String.format()

LOG.info("User '{}' changed the '{}' enrichment config to {}", SecurityUtils.getCurrentUser(), name, sensorEnrichmentConfig.toString());