feat(rules): implement declarative Automated Rules #749
Conversation
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
andrewazores
added
feat
andrewazores
force-pushed
the
declarative-rules
branch
2 times, most recently
from
637623c to
306d541
Compare
|
This PR/issue depends on: |
7 tasks
|
/build_test |
|
Workflow started at 12/19/2024, 7:22:14 PM. View Actions Run. |
andrewazores
force-pushed
the
declarative-rules
branch
from
f447e9e to
df06866
Compare
|
No GraphQL schema changes detected. |
|
No OpenAPI schema changes detected. |
|
CI build and push: At least one test failed ❌ |
|
/build_test |
|
Workflow started at 12/19/2024, 9:52:21 PM. View Actions Run. |
|
No GraphQL schema changes detected. |
|
No OpenAPI schema changes detected. |
|
CI build and push: All tests pass ✅ |
andrewazores
force-pushed
the
declarative-rules
branch
from
724905b to
27d7fb8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Welcome to Cryostat! 👋
Before contributing, make sure you have:
mainbranch[chore, ci, docs, feat, fix, test]To recreate commits with GPG signature
git fetch upstream && git rebase --force --gpg-sign upstream/mainBased on #735
Depends on #735
Fixes #548
Fixes #727
Description of the change:
Adds a declarative configuration directory for Automated Rules and implements loading definitions from this directory at startup.
Motivation for the change:
This will allow users to preload Automated Rules into their Cryostat installations without needing to go through the web UI or API calls. It also allows us to ship pre-written Rule definitions as part of the base container image.
For practical usage, end users who are using JMX for target connections should have JMX authentication configured. In that case, #720 would also need to be complete for the user to make full use of declarative Automated Rules. Otherwise, users can declaratively configure their own Automated Rules, but will still need to go through the UI or API to define the corresponding stored credentials. For users who are using the Cryostat Agent this will already work out of the box, since the Agent registers its own stored credentials.
Since this also provides preset Automated Rules as part of the container image, it's also useful as a way for us to ship example rule configurations for users to reference when crafting their own.
How to manually test:
./smoketest.bash -OquarkusRule predefined as part of this PR.quarkusRule. Enable the Rule and anauto_quarkusrecording should be started on Cryostat. See feat(matchexpressions): expressions can reference target JFR event type IDs #735 and feat(eventtemplates): add Preset event templates type and Quarkus-specific preset #733