[ML] Daylight saving time calendar events #193605

jgowdyelastic · 2024-09-20T15:14:04Z

Adds new pages for creating and managing DST calendars.
Closes #189469

New section added to Settings home page.

New page for listing DST calendars. The original calendar page does not show DST calendars.

New page for creating DST calendars.
The ability to apply to all jobs and add a description has been removed.
It is not possible manually add events. Events are automatically generated for a selected time zone.

If the selected time zone does not observe daylight savings, an info callout is displayed

A new DST calendar section is added to all AD job wizards.

jgowdyelastic · 2024-09-20T15:22:09Z

/ci

jgowdyelastic · 2024-09-24T13:08:17Z

/ci

jgowdyelastic · 2024-09-24T15:52:24Z

/ci

jgowdyelastic · 2024-09-30T10:02:11Z

/ci

jgowdyelastic · 2024-10-01T14:52:40Z

x-pack/plugins/ml/public/application/settings/anomaly_detection_settings.tsx

+              <p>
+                <FormattedMessage
+                  id="xpack.ml.settings.anomalyDetection.calendarsDstText"
+                  defaultMessage="Calendars contain a list of scheduled events for which you do not want to generate anomalies, such as planned system outages or public holidays."


@szabosteve could you please help with the text for this page.
This text is copied from the normal calendar page, but should instead be about these new DST calendars.

Also the link here goes to our documentation which will need updating.
https://www.elastic.co/guide/en/machine-learning/master/ml-ad-run-jobs.html#ml-ad-calendars

jgowdyelastic · 2024-10-01T14:55:55Z

...ents/job_details_step/components/additional_section/components/calendars/description_dst.tsx

+      description={
+        <FormattedMessage
+          id="xpack.ml.newJob.wizard.jobDetailsStep.additionalSection.calendarsDstSelection.description"
+          defaultMessage="Something about DST calendars. {learnMoreLink}"


@szabosteve can you help me with the text for this section which appears in the AD job wizard?

szabosteve

Please see my suggestions for the DST calendar short description below and let me know what you think.

x-pack/plugins/ml/public/application/settings/anomaly_detection_settings.tsx

...ents/job_details_step/components/additional_section/components/calendars/description_dst.tsx

x-pack/plugins/ml/public/application/settings/anomaly_detection_settings.tsx

x-pack/plugins/ml/public/application/settings/calendars/list/header.tsx

.../plugins/ml/public/application/settings/calendars/edit/calendar_form/dst_event_generator.tsx

peteharverson · 2024-10-03T12:17:57Z

.../plugins/ml/public/application/settings/calendars/edit/calendar_form/dst_event_generator.tsx

+            singleSelection={{ asPlainText: true }}
+            options={timeZoneOptions}
+            selectedOptions={selectedTimeZones}
+            onChange={setSelectedTimeZones}


I wonder if it's better to clear the table of events onChange? Otherwise it can appear that new DST events have been generated without having to press the 'Generate' button as the times in the table change.

Updated in db72ef0
The list is replaced when events are generated. I've also removed the generate button completely. Events are now created when a timezone is selected.

rbrtj

Code LGTM, left a few questions and nitpicks

rbrtj · 2024-10-03T10:28:39Z

x-pack/plugins/ml/public/application/routing/breadcrumbs.ts

+  text: i18n.translate('xpack.ml.settings.breadcrumbs.calendarManagementLabel', {
+    defaultMessage: 'Calendar DST management',
+  }),
+  href: '/settings/calendars_dst_list',


Q: I see that each breadcrumb is implemented this way, so it's not strictly related to the PR, but why aren't we using locator constants instead of plain strings?

we probably should be using those here.
I believe these breadcrumb files pre-date the introduction of the locator constants.

rbrtj · 2024-10-03T11:43:26Z

x-pack/plugins/ml/public/application/settings/calendars/dst_utils.test.ts

+    const events = createDstEvents(timezone);
+
+    // Each year should have 2 events (start and end of DST)
+    const expectedNumberOfEvents = 20 * 2;


Nit: Maybe we could reuse YEARS_OF_DST_EVENTS instead of 20?

I originally wrote it that way, but then decided that if someone changes YEARS_OF_DST_EVENTS it should be caught in the test as a regression.

rbrtj · 2024-10-03T12:03:35Z

x-pack/plugins/ml/public/application/settings/calendars/edit/calendar_form/calendar_form.tsx

Nit: With that rewrite to TS, maybe we could also convert the corresponding index.js file, which exports the component, to TS?

yes, good spot. that file can change

rbrtj · 2024-10-03T12:21:31Z

x-pack/plugins/ml/public/application/settings/calendars/edit/new_calendar.js

@@ -13,7 +13,7 @@ import { i18n } from '@kbn/i18n';
 import { EuiPageBody } from '@elastic/eui';

 import { getCalendarSettingsData, validateCalendarId } from './utils';
-import { CalendarForm } from './calendar_form';
+import { CalendarForm } from './calendar_form/calendar_form';


Q: Why are we directly importing from the file instead?

I think this is just a vscode autocomplete change. I'll change it back.

.../job_details_step/components/additional_section/components/calendars/calendars_selection.tsx

x-pack/plugins/ml/public/application/settings/calendars/edit/calendar_form/calendar_form.tsx

kibana-ci · 2024-10-07T12:33:56Z

💚 Build Succeeded

Buildkite Build
Commit: 1a6b4c4

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`ml`	2041	2044	+3

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`ml`	4.6MB	4.6MB	+10.8KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`ml`	74.4KB	74.8KB	+483.0B

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
`ml`	563	567	+4

Total ESLint disabled count

id	before	after	diff
`ml`	566	570	+4

History

💛 Build #239545 was flaky fea06b1
💛 Build #239369 was flaky b2ce67e
💔 Build #239332 failed 70fa935
💔 Build #239192 failed 65a40dc
💚 Build #239113 succeeded 2d0bb82
💚 Build #238707 succeeded 5c4e367

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @jgowdyelastic

peteharverson

Tested latest changes and LGTM

kibanamachine · 2024-10-07T13:35:45Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11216718699

Adds new pages for creating and managing DST calendars. Closes elastic#189469 New section added to Settings home page. ![image](https://github.com/user-attachments/assets/9165906f-e571-46be-a5ac-bf7dc9cd2801) New page for listing DST calendars. The original calendar page does not show DST calendars. ![image](https://github.com/user-attachments/assets/32a64a31-b4e5-4516-85fd-19e63aa9d5c4) New page for creating DST calendars. The ability to apply to all jobs and add a description has been removed. It is not possible manually add events. Events are automatically generated for a selected time zone. <img width="1170" alt="image" src="https://github.com/user-attachments/assets/557b8d39-6c17-448a-aa30-a282d8a424a7"> If the selected time zone does not observe daylight savings, an info callout is displayed <img width="1178" alt="image" src="https://github.com/user-attachments/assets/627043bf-0368-4ab3-8ca7-1931f9622387"> A new DST calendar section is added to all AD job wizards. ![image](https://github.com/user-attachments/assets/6359192b-faac-4ffb-ad3e-b8193f40f02f) (cherry picked from commit 2881b04)

kibanamachine · 2024-10-07T13:40:15Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

# Backport This will backport the following commits from `main` to `8.x`: - [[ML] Daylight saving time calendar events (#193605)](#193605)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: James Gowdy <jgowdy@elastic.co>

Fixing a typo in the ML locator switch statement which is missing a `break` for the edit calendar page. Bug introduced in #193605 Currently there are no instances where the locator is used to find this page, so this is not something which will affect the user, but it needs still fixing. ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_node:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] [See some risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) - [ ] ...

Fixing a typo in the ML locator switch statement which is missing a `break` for the edit calendar page. Bug introduced in elastic#193605 Currently there are no instances where the locator is used to find this page, so this is not something which will affect the user, but it needs still fixing. ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_node:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] [See some risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) - [ ] ... (cherry picked from commit 2d970dc)

Fixing a typo in the ML locator switch statement which is missing a `break` for the edit calendar page. Bug introduced in elastic#193605 Currently there are no instances where the locator is used to find this page, so this is not something which will affect the user, but it needs still fixing. ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_node:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] [See some risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) - [ ] ...

[ML] Daylight saving time calendar events

635bc9f

jgowdyelastic added 3 commits September 24, 2024 13:46

Merge branch 'main' into daylight-savings-calendar-events

08712f4

fixes after merge with main

73a7d36

translations

9cf2c1e

jgowdyelastic added 2 commits September 24, 2024 15:57

fixing paths to edit calendar

18b6985

fixing jest tests

54ec6b3

jgowdyelastic added 7 commits September 25, 2024 08:59

translations

2386227

Merge branch 'main' into daylight-savings-calendar-events

e46008b

Merge branch 'main' into daylight-savings-calendar-events

47f90ec

adding dst calendar to job wizards

8bb0914

fixing link to management list

143f632

settings layout

a610b67

Merge branch 'main' into daylight-savings-calendar-events

8c3c930

jgowdyelastic added 3 commits October 1, 2024 12:57

snapshot

c2ce577

Merge branch 'main' into daylight-savings-calendar-events

a7e4c5d

start and end tooltips

9f56e20

jgowdyelastic commented Oct 1, 2024

View reviewed changes

adding tests

a68823c

szabosteve reviewed Oct 2, 2024

View reviewed changes

x-pack/plugins/ml/public/application/settings/anomaly_detection_settings.tsx Outdated Show resolved Hide resolved

...ents/job_details_step/components/additional_section/components/calendars/description_dst.tsx Outdated Show resolved Hide resolved

text update

958a4d7

jgowdyelastic requested review from alvarezmelissa87, peteharverson and rbrtj October 2, 2024 10:23

Merge branch 'main' into daylight-savings-calendar-events

14dd326

jgowdyelastic marked this pull request as ready for review October 2, 2024 10:23

jgowdyelastic requested a review from a team as a code owner October 2, 2024 10:23

peteharverson mentioned this pull request Oct 3, 2024

[ML] Increase Test Coverage 8.16.0 #188459

Closed

23 tasks

peteharverson reviewed Oct 3, 2024

View reviewed changes

rbrtj approved these changes Oct 3, 2024

View reviewed changes

jgowdyelastic added 2 commits October 3, 2024 13:47

Merge branch 'main' into daylight-savings-calendar-events

2d0bb82

small changes based on review

4d5ef3a

peteharverson reviewed Oct 3, 2024

View reviewed changes

.../job_details_step/components/additional_section/components/calendars/calendars_selection.tsx Show resolved Hide resolved

peteharverson reviewed Oct 3, 2024

View reviewed changes

x-pack/plugins/ml/public/application/settings/calendars/edit/calendar_form/calendar_form.tsx Show resolved Hide resolved

jgowdyelastic added 8 commits October 3, 2024 15:48

removing generate button

db72ef0

translations

8b636dc

fixing bug with job wizard

5b1a167

Merge branch 'main' into daylight-savings-calendar-events

65a40dc

Merge branch 'main' into daylight-savings-calendar-events

70fa935

snapshots

b2ce67e

Merge branch 'main' into daylight-savings-calendar-events

fea06b1

Merge branch 'main' into daylight-savings-calendar-events

1a6b4c4

peteharverson approved these changes Oct 7, 2024

View reviewed changes

jgowdyelastic merged commit 2881b04 into elastic:main Oct 7, 2024
21 checks passed

jgowdyelastic deleted the daylight-savings-calendar-events branch October 7, 2024 13:35

kibanamachine mentioned this pull request Oct 7, 2024

[8.x] [ML] Daylight saving time calendar events (#193605) #195262

Merged

jgowdyelastic mentioned this pull request Nov 19, 2024

[ML] Fixing edit calendar locator #200681

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ML] Daylight saving time calendar events #193605

[ML] Daylight saving time calendar events #193605

jgowdyelastic commented Sep 20, 2024 •

edited by kibanamachine

Loading

jgowdyelastic commented Sep 20, 2024

jgowdyelastic commented Sep 24, 2024

jgowdyelastic commented Sep 24, 2024

jgowdyelastic commented Sep 30, 2024

jgowdyelastic Oct 1, 2024 •

edited

Loading

jgowdyelastic Oct 1, 2024

szabosteve left a comment

peteharverson Oct 3, 2024

jgowdyelastic Oct 3, 2024

rbrtj left a comment

rbrtj Oct 3, 2024

jgowdyelastic Oct 3, 2024

rbrtj Oct 3, 2024

jgowdyelastic Oct 3, 2024

rbrtj Oct 3, 2024 •

edited

Loading

jgowdyelastic Oct 3, 2024

rbrtj Oct 3, 2024

jgowdyelastic Oct 3, 2024

kibana-ci commented Oct 7, 2024

ESLint disabled line counts

Total ESLint disabled count

peteharverson left a comment

kibanamachine commented Oct 7, 2024

kibanamachine commented Oct 7, 2024

[ML] Daylight saving time calendar events #193605

[ML] Daylight saving time calendar events #193605

Conversation

jgowdyelastic commented Sep 20, 2024 • edited by kibanamachine Loading

jgowdyelastic commented Sep 20, 2024

jgowdyelastic commented Sep 24, 2024

jgowdyelastic commented Sep 24, 2024

jgowdyelastic commented Sep 30, 2024

jgowdyelastic Oct 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szabosteve left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rbrtj left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rbrtj Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibana-ci commented Oct 7, 2024

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

ESLint disabled line counts

Total ESLint disabled count

History

peteharverson left a comment

Choose a reason for hiding this comment

kibanamachine commented Oct 7, 2024

kibanamachine commented Oct 7, 2024

💚 All backports created successfully

Questions ?

jgowdyelastic commented Sep 20, 2024 •

edited by kibanamachine

Loading

jgowdyelastic Oct 1, 2024 •

edited

Loading

rbrtj Oct 3, 2024 •

edited

Loading