open-policy-agent / open-policy-agent/frameworks
improving match criteria debuggability
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 127
- Forks
- 61
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 13
Description
At present, we only record results that match a constraint match criteria:
We can improve the debuggability of the system by A) indicating that a constraint doesn't match for a review and B) any stats on time it takes to run the match for a constraint. Both of these can help with UX efforts in shift left case scenarios like https://github.com/open-policy-agent/gatekeeper/issues/2599
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with constraint/pkg/client/template_client.go around lines 135-140, where only matching results are recorded. Trace how match results are reviewed and determine how non-matches and match-duration statistics should be represented. Done means reviews can identify constraints that did not match and can access timing data for each constraint match.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100