[Heartbeat] Adds maintenance windows !! by shahzad31 · Pull Request #41508 · elastic/beats

shahzad31 · 2024-11-04T14:54:21Z

Proposed commit message

Added maintenance windows in heartbeat in RFC 5545 format using rrule-go library, this makes it compatible with kibana alerting maintenance windows which are using the same format https://www.elastic.co/guide/en/kibana/current/maintenance-windows.html

This will allow us to simple pass values from alerting maintenance windows where those are applicable to synthetics monitors as heartbeat configs

example being

heartbeat.monitors:

- type: http
  id: my-monitor
  urls: ["http://localhost:9200"]
  maintenance_windows:
    - freq: daily
      dtstart: "2024-11-04T01:00:00.000Z"
      interval: 1
      byweekday: [MO, TU, WE, TH, FR]
      duration: 3600000

Limitations

Only Daily, weekly, Monthly and Yearly Frequencies are allowed.
If DTStart is older than 2 years, it will throw error.

Checklist

My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have made corresponding change to the default configuration files
I have added tests that prove my fix is effective or that my feature works
I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Disruptive User Impact

Author's Checklist

[ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

mergify · 2024-11-04T14:54:56Z

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @shahzad31? 🙏.
For such, you'll need to label your PR with:

The upcoming major version of the Elastic Stack
The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit

mergify · 2024-11-04T14:54:56Z

backport-8.x has been added to help with the transition to the new branch 8.x.
If you don't need it please use backport-skip label and remove the backport-8.x label.

elasticmachine · 2024-11-04T14:55:35Z

Pinging @elastic/obs-ds-hosted-services (Team:obs-ds-hosted-services)

heartbeat/heartbeat.yml

…nce-windows

cmacknz

Approving go.mod changes.

mergify · 2024-11-12T05:38:14Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b maintenance-windows upstream/maintenance-windows
git merge upstream/main
git push upstream maintenance-windows

heartbeat/scheduler/scheduler.go

heartbeat/monitors/maintwin/maintwin.go

heartbeat/scheduler/scheduler.go

emilioalvap

LGTM with suggestions 🚀

heartbeat/monitors/maintwin/maintwin.go

Co-authored-by: Emilio Alvarez Piñeiro <95703246+emilioalvap@users.noreply.github.com>

…nce-windows

emilioalvap · 2025-02-17T15:45:17Z

/test

shahzad31 · 2025-02-17T19:47:17Z

/test

* Add maint windows * Initial maint win MVP * added maintenance windows * destroy cluster * format * revert file * revert file * added lib * revert * space * add license * update * update * fix tests * lint * skip run once * Fix linting * Remove unused fields * Make update * add more test cases * utc * lint * handle errors * bit of refactor * emilio suggestion * More PR feedback * lint * add validation for map * nil condition * set count to default * add validation for only daily * add dt start validation * revrt * revrt * revert * revert * format * PR feedback * add docs * Update heartbeat/monitors/maintwin/maintwin.go Co-authored-by: Emilio Alvarez Piñeiro <95703246+emilioalvap@users.noreply.github.com> * Update heartbeat/monitors/maintwin/maintwin.go Co-authored-by: Emilio Alvarez Piñeiro <95703246+emilioalvap@users.noreply.github.com> * fomat * change log --------- Co-authored-by: Andrew Cholakian <andrewvc@elastic.co> Co-authored-by: emilioalvap <emilio.alvarezpineiro@elastic.co> Co-authored-by: Emilio Alvarez Piñeiro <95703246+emilioalvap@users.noreply.github.com> (cherry picked from commit f6fb08d) # Conflicts: # go.mod # go.sum

* [Heartbeat] Adds maintenance windows !! (#41508) * Add maint windows * Initial maint win MVP * added maintenance windows * destroy cluster * format * revert file * revert file * added lib * revert * space * add license * update * update * fix tests * lint * skip run once * Fix linting * Remove unused fields * Make update * add more test cases * utc * lint * handle errors * bit of refactor * emilio suggestion * More PR feedback * lint * add validation for map * nil condition * set count to default * add validation for only daily * add dt start validation * revrt * revrt * revert * revert * format * PR feedback * add docs * Update heartbeat/monitors/maintwin/maintwin.go Co-authored-by: Emilio Alvarez Piñeiro <95703246+emilioalvap@users.noreply.github.com> * Update heartbeat/monitors/maintwin/maintwin.go Co-authored-by: Emilio Alvarez Piñeiro <95703246+emilioalvap@users.noreply.github.com> * fomat * change log --------- Co-authored-by: Andrew Cholakian <andrewvc@elastic.co> Co-authored-by: emilioalvap <emilio.alvarezpineiro@elastic.co> Co-authored-by: Emilio Alvarez Piñeiro <95703246+emilioalvap@users.noreply.github.com> (cherry picked from commit f6fb08d) # Conflicts: # go.mod # go.sum * Fix conflicts --------- Co-authored-by: Shahzad <shahzad31comp@gmail.com> Co-authored-by: emilioalvap <emilio.alvarezpineiro@elastic.co>

andrewvc and others added 6 commits January 18, 2023 20:32

Add maint windows

6824d0d

Initial maint win MVP

4593430

Merge branch 'main' into maint-win

b8a4d3c

added maintenance windows

e75ec1d

destroy cluster

09b0587

format

1a722aa

shahzad31 added the enhancement label Nov 4, 2024

shahzad31 requested review from a team as code owners November 4, 2024 14:54

botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Nov 4, 2024

mergify bot assigned shahzad31 Nov 4, 2024

mergify bot added the backport-8.x Automated backport to the 8.x branch with mergify label Nov 4, 2024

pierrehilbert added the Team:obs-ds-hosted-services Label for the Observability Hosted Services team label Nov 4, 2024

botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Nov 4, 2024

shahzad31 added 3 commits November 4, 2024 15:57

revert file

82e3faf

revert file

3d3d14f

added lib

b16af0d

emilioalvap reviewed Nov 5, 2024

View reviewed changes

heartbeat/heartbeat.yml Outdated Show resolved Hide resolved

emilioalvap reviewed Nov 5, 2024

View reviewed changes

heartbeat/heartbeat.yml Outdated Show resolved Hide resolved

shahzad31 added 4 commits November 6, 2024 11:12

revert

f3db602

Merge branch 'main' of https://github.com/elastic/beats into maintena…

87410e9

…nce-windows

space

2693d6a

add license

7ae80b7

cmacknz approved these changes Nov 6, 2024

View reviewed changes

shahzad31 added 2 commits November 14, 2024 11:39

update

b7b9f29

Merge remote-tracking branch 'upstream/main' into maintenance-windows

3a792e1

add validation for only daily

4da6fc1

emilioalvap reviewed Feb 13, 2025

View reviewed changes

heartbeat/scheduler/scheduler.go Outdated Show resolved Hide resolved

shahzad31 added 6 commits February 13, 2025 19:17

add dt start validation

3551154

revrt

5f32cb6

revrt

88f3f3d

revert

954b78d

revert

734e85b

format

e9c2e61

emilioalvap reviewed Feb 14, 2025

View reviewed changes

heartbeat/monitors/maintwin/maintwin.go Outdated Show resolved Hide resolved

emilioalvap reviewed Feb 14, 2025

View reviewed changes

heartbeat/scheduler/scheduler.go Outdated Show resolved Hide resolved

PR feedback

ad3ec73

emilioalvap approved these changes Feb 14, 2025

View reviewed changes

heartbeat/monitors/maintwin/maintwin.go Outdated Show resolved Hide resolved

heartbeat/monitors/maintwin/maintwin.go Outdated Show resolved Hide resolved

shahzad31 and others added 5 commits February 17, 2025 09:40

add docs

7b13c96

Update heartbeat/monitors/maintwin/maintwin.go

f0f96b3

Co-authored-by: Emilio Alvarez Piñeiro <95703246+emilioalvap@users.noreply.github.com>

Update heartbeat/monitors/maintwin/maintwin.go

f28455a

Co-authored-by: Emilio Alvarez Piñeiro <95703246+emilioalvap@users.noreply.github.com>

fomat

897f3e7

Merge branch 'main' of https://github.com/elastic/beats into maintena…

a80dc6e

…nce-windows

change log

364bc72

shahzad31 merged commit f6fb08d into elastic:main Feb 18, 2025
144 checks passed

shahzad31 deleted the maintenance-windows branch February 18, 2025 06:21

shahzad31 removed the backport-8.x Automated backport to the 8.x branch with mergify label Feb 18, 2025

This was referenced Feb 18, 2025

[Synthetics] Added field for maintenance windows !! elastic/integrations#12820

Merged

[Synthetics] Add maintenance windows support !! elastic/kibana#211540

Closed

[Alerting] Allow call back actions for maintenance windows elastic/kibana#211579

Closed

shahzad31 added the backport-8.19 Automated backport to the 8.19 branch label Jun 6, 2025

mergify bot mentioned this pull request Jun 6, 2025

[8.19](backport #41508) [Heartbeat] Adds maintenance windows !! #44689

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Heartbeat] Adds maintenance windows !!#41508

[Heartbeat] Adds maintenance windows !!#41508
shahzad31 merged 49 commits intoelastic:mainfrom
shahzad31:maintenance-windows

shahzad31 commented Nov 4, 2024 •

edited

Loading

mergify bot commented Nov 4, 2024

mergify bot commented Nov 4, 2024

elasticmachine commented Nov 4, 2024

Uh oh!

Uh oh!

cmacknz left a comment

mergify bot commented Nov 12, 2024

Uh oh!

Uh oh!

Uh oh!

emilioalvap left a comment

Uh oh!

Uh oh!

emilioalvap commented Feb 17, 2025

shahzad31 commented Feb 17, 2025

Uh oh!

Labels

6 participants

Conversation

shahzad31 commented Nov 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed commit message

Limitations

Checklist

Disruptive User Impact

Author's Checklist

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

mergify bot commented Nov 4, 2024

mergify bot commented Nov 4, 2024

elasticmachine commented Nov 4, 2024

Uh oh!

Uh oh!

cmacknz left a comment

Choose a reason for hiding this comment

mergify bot commented Nov 12, 2024

Uh oh!

Uh oh!

Uh oh!

emilioalvap left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

emilioalvap commented Feb 17, 2025

shahzad31 commented Feb 17, 2025

Uh oh!

Labels

6 participants

shahzad31 commented Nov 4, 2024 •

edited

Loading