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: PC-13724 Add custom thresholds for SHR #530

Merged

Conversation

lukasz-dobek
Copy link
Contributor

@lukasz-dobek lukasz-dobek commented Aug 26, 2024

Motivation

Currently, System Health Review report is built using error budget remaining metric. Whether an SLO is marked as Red (Exhausted), Green (Healthy), or Yellow (At Risk) depends upon a static value. This PR opens up a window towards user-defined thresholds. If user decides that SLO should be marked as Healthy when it has more than 50% budget remaining, they will set spec.systemHealthReview.thresholds.greenGt field to 0.5. If user wants to remove AtRisk threshold, they will set spec.systemHealthReview.thresholds.redLte to the same value as greenGt (0.5). Additionally, if users decides that NoData SLOs are supposed to be displayed on their report, a field ShowNoData is provided that can be set to true in such case.

Summary

Thresholds object with three fields (GreenGreaterThan, RedLessThanOrEqualTo and ShowNoData) was added to SystemHealthReviewConfig along with validation of said fields.

Release Notes

Thresholds object with three fields (GreenGreaterThan, RedLessThanOrEqualTo and ShowNoData) was added to SystemHealthReviewConfig. It allows users to define custom values for Healthy (Green), AtRisk (Yellow) and Exhausted (Red) thresholds and to decide whether to display or hide NoData SLOs on System Health Review report. It will be available once Nobl9 platform version 1.97.2 is released.

@n9-machine-user n9-machine-user added enhancement New feature or request go minor labels Aug 26, 2024
@lukasz-dobek lukasz-dobek marked this pull request as ready for review August 28, 2024 10:40
@lukasz-dobek lukasz-dobek changed the title feat: PC-13724 Add report thresholds feat: PC-13724 Add custom thresholds for SHR Sep 5, 2024
@KajetanKurkiewicz KajetanKurkiewicz added the passed-testing Added by QA when tests have passed label Sep 6, 2024
@lukasz-dobek lukasz-dobek enabled auto-merge (squash) September 6, 2024 14:33
@lukasz-dobek lukasz-dobek merged commit 107fd6f into main Sep 6, 2024
5 checks passed
@lukasz-dobek lukasz-dobek deleted the PC-13724-allow-users-to-customize-thresholds-via-yaml branch September 6, 2024 14:37
renovate bot referenced this pull request in nobl9/sloctl Sep 11, 2024
This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[github.com/nobl9/nobl9-go](https://redirect.github.com/nobl9/nobl9-go)
| `v0.84.1-rc3` -> `v0.84.1-rc4` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fnobl9%2fnobl9-go/v0.84.1-rc4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fnobl9%2fnobl9-go/v0.84.1-rc4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fnobl9%2fnobl9-go/v0.84.1-rc3/v0.84.1-rc4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fnobl9%2fnobl9-go/v0.84.1-rc3/v0.84.1-rc4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>nobl9/nobl9-go (github.com/nobl9/nobl9-go)</summary>

###
[`v0.84.1-rc4`](https://redirect.github.com/nobl9/nobl9-go/releases/tag/v0.84.1-rc4)

[Compare
Source](https://redirect.github.com/nobl9/nobl9-go/compare/v0.84.1-rc3...v0.84.1-rc4)

#### What's Changed

- chore: Update dependency yaml to v2.5.1 by
[@&#8203;renovate](https://redirect.github.com/renovate) in
[https://github.com/nobl9/nobl9-go/pull/532](https://redirect.github.com/nobl9/nobl9-go/pull/532)
- chore: Update module golang.org/x/text to v0.18.0 by
[@&#8203;renovate](https://redirect.github.com/renovate) in
[https://github.com/nobl9/nobl9-go/pull/535](https://redirect.github.com/nobl9/nobl9-go/pull/535)
- feat: PC-13724 Add custom thresholds for SHR by
[@&#8203;lukasz-dobek](https://redirect.github.com/lukasz-dobek) in
[https://github.com/nobl9/nobl9-go/pull/530](https://redirect.github.com/nobl9/nobl9-go/pull/530)
- chore: Update module golang.org/x/tools/cmd/goimports to v0.25.0 by
[@&#8203;renovate](https://redirect.github.com/renovate) in
[https://github.com/nobl9/nobl9-go/pull/540](https://redirect.github.com/nobl9/nobl9-go/pull/540)
- chore: export metric spec validation rules by
[@&#8203;kuklyy](https://redirect.github.com/kuklyy) in
[https://github.com/nobl9/nobl9-go/pull/536](https://redirect.github.com/nobl9/nobl9-go/pull/536)

**Full Changelog**:
nobl9/nobl9-go@v0.84.1-rc3...v0.84.1-rc4

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 10pm every weekday,before 5am
every weekday,every weekend" (UTC), Automerge - At any time (no schedule
defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend Renovate](https://mend.io/renovate/).
View the [repository job
log](https://developer.mend.io/github/nobl9/sloctl).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC41OS4yIiwidXBkYXRlZEluVmVyIjoiMzguNTkuMiIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIiwiZ29sYW5nIiwicmVub3ZhdGUiXX0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
natalialanga added a commit to nobl9/terraform-provider-nobl9 that referenced this pull request Sep 23, 2024
## Summary

Add support for managing System Health Review Report via terraform.

## Related Changes

nobl9/nobl9-go#495
nobl9/nobl9-go#530

## Testing

TBD

## Release Notes

Handle creating, updating and deleting reports. Only System Health
Review report type is currently supported.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request go minor passed-testing Added by QA when tests have passed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants