This is a set of app inspect custom checks to make sure certain best practices are followed.
You will need to follow these directions. If you have existing custom checks, you will need to copy the python files from the checks directory into your existing directory.
Then when you run splunk_appinspect CLI you will need to specify --custom-checks-dir and pass in the directory containing the custom checks. You will also want to include --included-tags best_practices to include these checks.
You can also run ./check_best_practices.sh <path_to_archive_or_app_folder> to run just the best practices checks, and output the results.
The doc strings for each check should give you an idea of what it checks. TODO flesh this out from doc strings.
TODO Enumerate them here
These check that the magic eight props.conf settings are configured. See Magic 8 for more details.
- transforms.conf checks
- Checking REGEX and FORMAT map together appropriately
- Check where unnamed capture group count matches format $var count.
- Unnamed capture group mixed in with named capture groups
- Is it valid to have FORMAT when your REGEX is just named capture groups?
- There might be lots of edge cases...
- Checking REGEX and FORMAT map together appropriately
TODO List them here.
Pull requests are welcome!
The code in this repository is licensed under the Apache License 2.0. See LICENSE for details.