Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(eventtemplates): custom event templates in S3 #290

Merged
merged 44 commits into from
Feb 22, 2024

Conversation

andrewazores
Copy link
Member

@andrewazores andrewazores commented Feb 15, 2024

Welcome to Cryostat3! 👋

Before contributing, make sure you have:

  • Read the contributing guidelines
  • Linked a relevant issue which this PR resolves
  • Linked any other relevant issues, PR's, or documentation, if any
  • Resolved all conflicts, if any
  • Rebased your branch PR on top of the latest upstream main branch
  • Attached at least one of the following labels to the PR: [chore, ci, docs, feat, fix, test]
  • Signed all commits using a GPG signature

To recreate commits with GPG signature git fetch upstream && git rebase --force --gpg-sign upstream/main


Fixes #13
Replaces #119
Related to #42

Description of the change:

This implements custom event template storage in S3. This works much the same as custom event templates do in 2.4.0, but rather than stored in a local filesystem location the templates are stored in and retrieved from S3.

How to manually test:

  1. Run CRYOSTAT_IMAGE=quay.io... bash smoketest.bash -Ot
  2. Go to Events
  3. Select a target
  4. Download an event template (other than ALL) - you should find ex. Profiling.jfc downloaded to your workstation. This step requires chore(templates): remove auth token download flow cryostat-web#1215 . Without it, you can check your workstation's JVM installation and look for ex. /usr/lib/jvm/java/lib/jfr/profile.jfc and use that as a base, instead: cp /usr/lib/jvm/java/lib/jfr/profile.jfc ~/Downloads/Profiling.jfc.
  5. Open Profiling.jfc with a text or XML editor, or the JMC event configuration wizard. Make some changes to the event template file, including changing the label, description, and provider attributes at the top.
  6. Back in the Cryostat UI, upload your modified event template back to Cryostat.
  7. Create a new Recording using your new event template.
  8. Delete the event template. This will display a notification but the UI table may not update - I think this is a -web bug. Navigating away and back to Events will show the correctly updated contents.

@andrewazores
Copy link
Member Author

/build_test

Copy link

Workflow started at 2/15/2024, 2:44:28 PM. View Actions Run.

Copy link

CI build and push: All tests pass ✅ (JDK21)
https://github.com/cryostatio/cryostat3/actions/runs/7921413698

Copy link

CI build and push: At least one test failed ❌ (JDK17)
https://github.com/cryostatio/cryostat3/actions/runs/7921413698

@andrewazores
Copy link
Member Author

/build_test

Copy link

Workflow started at 2/15/2024, 3:06:13 PM. View Actions Run.

Copy link

CI build and push: All tests pass ✅ (JDK21)
https://github.com/cryostatio/cryostat3/actions/runs/7921650623

Copy link

CI build and push: At least one test failed ❌ (JDK17)
https://github.com/cryostatio/cryostat3/actions/runs/7921650623

@andrewazores andrewazores marked this pull request as draft February 15, 2024 20:26
@andrewazores
Copy link
Member Author

Figuring out the test failures.

@andrewazores
Copy link
Member Author

/build_test

@andrewazores andrewazores marked this pull request as ready for review February 16, 2024 03:21
Copy link

Workflow started at 2/15/2024, 10:22:00 PM. View Actions Run.

Copy link

CI build and push: All tests pass ✅ (JDK21)
https://github.com/cryostatio/cryostat3/actions/runs/7925588240

Copy link

CI build and push: All tests pass ✅ (JDK17)
https://github.com/cryostatio/cryostat3/actions/runs/7925588240

@andrewazores
Copy link
Member Author

/build_test

Copy link

Workflow started at 2/15/2024, 10:39:09 PM. View Actions Run.

Copy link

CI build and push: All tests pass ✅ (JDK21)
https://github.com/cryostatio/cryostat3/actions/runs/7925706491

Copy link

CI build and push: All tests pass ✅ (JDK17)
https://github.com/cryostatio/cryostat3/actions/runs/7925706491

@andrewazores
Copy link
Member Author

/build_test

Copy link

Workflow started at 2/15/2024, 10:50:52 PM. View Actions Run.

Copy link

CI build and push: All tests pass ✅ (JDK21)
https://github.com/cryostatio/cryostat3/actions/runs/7925770667

Copy link

CI build and push: All tests pass ✅ (JDK17)
https://github.com/cryostatio/cryostat3/actions/runs/7925770667

@andrewazores
Copy link
Member Author

/build_test

Copy link

Workflow started at 2/21/2024, 3:32:05 PM. View Actions Run.

Copy link

CI build and push: All tests pass ✅ (JDK21)
https://github.com/cryostatio/cryostat3/actions/runs/7995196878

Copy link

CI build and push: All tests pass ✅ (JDK17)
https://github.com/cryostatio/cryostat3/actions/runs/7995196878

Copy link
Contributor

@aali309 aali309 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, was very nice seeing the outcome. Looks good to me.

@andrewazores andrewazores merged commit 1bfcac7 into main Feb 22, 2024
8 checks passed
@andrewazores andrewazores deleted the 13-custom-event-templates branch February 22, 2024 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat New feature or request safe-to-test
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[Story] Custom event templates
3 participants