[ML] Data Frame Analytics custom URLs: adds ability to set custom time range in urls #155337

alvarezmelissa87 · 2023-04-20T01:35:17Z

Summary

Related meta issue: #150375

This PR adds a custom time range picker to the custom urls UI for Data Frame Analytics jobs.
When not selected, the timerange will default to the global timerange - this is the same behavior as before.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

elasticmachine · 2023-04-20T01:35:20Z

Pinging @elastic/ml-ui (:ml)

x-pack/plugins/ml/public/application/components/custom_urls/custom_url_editor/editor.tsx

.../ml/public/application/components/custom_urls/custom_url_editor/custom_time_range_picker.tsx

peteharverson · 2023-04-20T16:50:40Z

.../ml/public/application/components/custom_urls/custom_url_editor/custom_time_range_picker.tsx

+      {showCustomTimeRangeSelector ? (
+        <>
+          <EuiSpacer size="s" />
+          <EuiFormRow


If the destination data view of the job has a timestamp field, and the target page is either Dashboard or Discover with a data view that has a timestamp field, it would be good to include an extra option here as well as the custom time range option, where the user can specify an interval. The action here would be to open the target page showing interval either side of the time of the row the action is being run on, similar to the option we have for anomaly detection job custom URLs:

This item is part of the overall meta issue #150375 and can be done in a separate PR 👍

peteharverson

Tested latest changes and LGTM

jgowdyelastic · 2023-04-21T16:29:37Z

.../ml/public/application/components/custom_urls/custom_url_editor/custom_time_range_picker.tsx

+    },
+  } = useMlKibana();
+
+  const onCustomTimeRangeSwitchChange = (e: {


The type of e can be e: React.ChangeEvent<HTMLInputElement>

But a neater way might be to just pass in a boolean and call onCustomTimeRangeSwitchChange with onChange={(e) => onCustomTimeRangeSwitchChange(e.target.checked)}
This is the style we've used the most in our code.

Good call - updated to use the consistent style in eca357a

jgowdyelastic · 2023-04-21T16:30:24Z

x-pack/plugins/ml/public/application/components/custom_urls/custom_url_editor/editor.tsx

@@ -29,10 +30,11 @@ import { DataView } from '@kbn/data-views-plugin/public';
 import { CustomUrlSettings, isValidCustomUrlSettingsTimeRange } from './utils';
 import { isValidLabel } from '../../../util/custom_url_utils';
 import { type DataFrameAnalyticsConfig } from '../../../../../common/types/data_frame_analytics';
-import { Job, isAnomalyDetectionJob } from '../../../../../common/types/anomaly_detection_jobs';
+import { Job } from '../../../../../common/types/anomaly_detection_jobs';


Suggested change

import { Job } from '../../../../../common/types/anomaly_detection_jobs';

import { type Job } from '../../../../../common/types/anomaly_detection_jobs';

Updated in eca357a

jgowdyelastic · 2023-04-21T16:34:19Z

x-pack/plugins/ml/public/application/components/custom_urls/custom_url_editor/utils.ts

@@ -252,12 +254,19 @@ async function buildDashboardUrlFromSettings(settings: CustomUrlSettings): Promi
  }

  const dashboard = getDashboard();
+  let customStart;


these two new blocks of code are identical, could they be moved to a small function that takes in settings?
it could even incorporate the customStart ?? '$earliest$' check later and just return from and to

Moved to a separate function in eca357a

alvarezmelissa87 · 2023-04-24T15:04:43Z

@elasticmachine merge upstream

alvarezmelissa87 · 2023-04-24T15:05:25Z

This has been updated with final suggestions 🙏 cc @jgowdyelastic, @peteharverson

jgowdyelastic

LGTM

alvarezmelissa87 · 2023-04-24T20:52:27Z

@elasticmachine merge upstream

kibana-ci · 2023-04-24T22:05:19Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: aad4207

Failed CI Steps

Test Failures

[job] [logs] FTR Configs #27 / analytics instrumented events from the browser Event "viewport_resize" should emit a "viewport_resize" event when the browser is resized
[job] [logs] FTR Configs #51 / machine learning - short tests model management trained models for ML power user with imported models stops deployment of the imported model pt_tiny_ner

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`ml`	1719	1720	+1

Async chunks

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

id	before	after	diff
`ml`	3.4MB	3.4MB	+2.6KB

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
`enterpriseSearch`	17	19	+2
`securitySolution`	395	398	+3
total			+5

Total ESLint disabled count

id	before	after	diff
`enterpriseSearch`	18	20	+2
`securitySolution`	475	478	+3
total			+5

History

💚 Build #122509 succeeded b355d3a
💚 Build #121814 succeeded 879af45
💚 Build #121772 succeeded b4350ca
💛 Build #121633 was flaky 6dd3e69
💔 Build #121381 failed e5da7e6

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

cc @alvarezmelissa87

create custom time range picker component for dfa custom urls

f8faa8f

alvarezmelissa87 added :ml release_note:skip Skip the PR/issue when compiling release notes Feature:Data Frame Analytics ML data frame analytics features v8.8.0 labels Apr 20, 2023

alvarezmelissa87 self-assigned this Apr 20, 2023

alvarezmelissa87 requested a review from a team as a code owner April 20, 2023 01:35

fix jest tests

e5da7e6

alvarezmelissa87 requested review from peteharverson and jgowdyelastic April 20, 2023 01:45

alvarezmelissa87 mentioned this pull request Apr 20, 2023

[ML] Data Frame Analytics results view: option to drill down from column to dashboard* #150375

Closed

4 tasks

Remove duplicate translation id

6dd3e69

peteharverson reviewed Apr 20, 2023

View reviewed changes

alvarezmelissa87 added 2 commits April 20, 2023 14:36

Merge branch 'main' into ml-custom-urls-add-timepicker-for-dfa

b4350ca

only show customTimeRangePicker if dataview has timefield

879af45

peteharverson approved these changes Apr 21, 2023

View reviewed changes

jgowdyelastic reviewed Apr 21, 2023

View reviewed changes

move custom time range determination to util function

eca357a

Merge branch 'main' into ml-custom-urls-add-timepicker-for-dfa

b355d3a

jgowdyelastic approved these changes Apr 24, 2023

View reviewed changes

Merge branch 'main' into ml-custom-urls-add-timepicker-for-dfa

aad4207

alvarezmelissa87 merged commit d5f12ac into elastic:main Apr 24, 2023

alvarezmelissa87 deleted the ml-custom-urls-add-timepicker-for-dfa branch April 24, 2023 22:20

kibanamachine added the backport:skip This commit does not require backporting label Apr 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ML] Data Frame Analytics custom URLs: adds ability to set custom time range in urls #155337

[ML] Data Frame Analytics custom URLs: adds ability to set custom time range in urls #155337

alvarezmelissa87 commented Apr 20, 2023 •

edited

Loading

elasticmachine commented Apr 20, 2023

peteharverson Apr 20, 2023

alvarezmelissa87 Apr 20, 2023

peteharverson left a comment

jgowdyelastic Apr 21, 2023

alvarezmelissa87 Apr 24, 2023

jgowdyelastic Apr 21, 2023

alvarezmelissa87 Apr 24, 2023

jgowdyelastic Apr 21, 2023

alvarezmelissa87 Apr 24, 2023

alvarezmelissa87 commented Apr 24, 2023

alvarezmelissa87 commented Apr 24, 2023

jgowdyelastic left a comment

alvarezmelissa87 commented Apr 24, 2023

kibana-ci commented Apr 24, 2023

ESLint disabled line counts

Total ESLint disabled count

	import { Job } from '../../../../../common/types/anomaly_detection_jobs';
	import { type Job } from '../../../../../common/types/anomaly_detection_jobs';

[ML] Data Frame Analytics custom URLs: adds ability to set custom time range in urls #155337

[ML] Data Frame Analytics custom URLs: adds ability to set custom time range in urls #155337

Conversation

alvarezmelissa87 commented Apr 20, 2023 • edited Loading

Summary

Checklist

elasticmachine commented Apr 20, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

peteharverson 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alvarezmelissa87 commented Apr 24, 2023

alvarezmelissa87 commented Apr 24, 2023

jgowdyelastic left a comment

Choose a reason for hiding this comment

alvarezmelissa87 commented Apr 24, 2023

kibana-ci commented Apr 24, 2023

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Async chunks

ESLint disabled line counts

Total ESLint disabled count

History

alvarezmelissa87 commented Apr 20, 2023 •

edited

Loading