[ML] AiOps: Action for adding Log Pattern embeddable to a dashboard and case #199478

rbrtj · 2024-11-08T13:40:05Z

Summary

Part of #197247

Added the ability to add a Log Pattern Embeddable to a dashboard and case.
Fixed the Change Point Detection embeddable in cases and added a functional test to cover this scenario.

Screen.Recording.2024-11-06.at.13.58.01.mov

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
Unit or functional tests were updated or added to match the most common scenarios

…actions

rbrtj · 2024-11-08T13:40:32Z

...s/log_categorization/log_categorization_for_embeddable/log_categorization_for_embeddable.tsx

+  const isCasesEmbeddable = embeddingOrigin === AIOPS_EMBEDDABLE_ORIGIN.CASES;
+
+  // Disable filtering for cases embeddable, as it's not possible to delete filters
+  const actions = [...(isCasesEmbeddable ? [] : getActions(false)), ...getActions(true)];


It disables filtering for a pattern in cases. In dashboards, it is possible to delete a filter, but there is currently no such option in cases. I have disabled it for now, but it would be nice to have that option available inside the embeddable.

rbrtj · 2024-11-08T13:40:57Z

...s/log_categorization/log_categorization_for_embeddable/log_categorization_for_embeddable.tsx


  return (
    <>
      <FieldValidationCallout validationResults={fieldValidationResult} />
-      {(loading ?? true) === true ? <LoadingCategorization onCancel={cancelRequest} /> : null}
+      {(loading ?? true) === true ? (
+        <LoadingCategorization onCancel={cancelRequest} disableCancelLoading={isCasesEmbeddable} />


Disabled cancel loading in cases because it is not possible to refresh the embeddable. Therefore, after canceling, the embeddable would get stuck without results.

rbrtj · 2024-11-08T13:41:17Z

...k/plugins/aiops/public/embeddables/change_point_chart/embeddable_chart_component_wrapper.tsx

@@ -101,10 +101,6 @@ export const ChartGridEmbeddableWrapper: FC<ChangePointDetectionProps> = ({
    10000
  );

-  useEffect(() => {


It was causing an error because onLoading is not defined for the chart change point embeddable component.

elasticmachine · 2024-11-08T13:43:25Z

Pinging @elastic/ml-ui (:ml)

walterra

Great update! I tested adding pattern analysis to dashboards&cases from the page. Added some minor comments:

walterra · 2024-11-08T14:05:56Z

x-pack/plugins/aiops/public/components/log_categorization/attachments_menu.tsx

+const SavedObjectSaveModalDashboard = withSuspense(LazySavedObjectSaveModalDashboard);
+
+interface AttachmentsMenuProps {
+  dataView: DataView;


Could this use useAiopsAppContext for some of the props here?

Done in: #c696e4e

walterra · 2024-11-08T14:06:17Z

x-pack/plugins/aiops/public/components/log_categorization/attachments_menu.tsx

+
+  const onSave: SaveModalDashboardProps['onSave'] = useCallback(
+    ({ dashboardId, newTitle, newDescription }) => {
+      const stateTransfer = embeddable!.getStateTransfer();


Nit: Is it possible to avoid the !? If you keep passing in embeddable via props you could make it non-optional, other maybe return early? (I saw it's the same for the change point one so probably fine to leave as is if too much trouble refactoring)

The embeddable is no longer passed as a prop since we're now calling useAiopsAppContext directly. In this scenario, I don't think there's much we can do about it. We could return early in the onSave callback, but that’s all.
I tried modifying the AiopsAppContext type to differentiate when embeddable should be defined, but achieving this isn’t that easy.

walterra · 2024-11-08T14:07:35Z

x-pack/plugins/aiops/public/components/log_categorization/loading_categorization.tsx

@@ -20,9 +20,10 @@ import { FormattedMessage } from '@kbn/i18n-react';

 interface Props {
  onCancel: () => void;
+  disableCancelLoading?: boolean;


Nit: An alternative to avoid another prop could be to make onCancel optional and set the button to disabled when it's not set.

Done in: #d162011

jgowdyelastic · 2024-11-08T13:48:18Z

x-pack/plugins/aiops/public/components/log_categorization/attachments_menu.tsx

+  randomSamplerProbability: RandomSamplerProbability;
+  embeddable?: EmbeddableStart;
+  cases?: CasesPublicStart;
+  capabilities?: Capabilities;


capabilities shouldn't be optional

Done in: #c696e4e
and #f5fdb03

jgowdyelastic · 2024-11-08T13:48:33Z

x-pack/plugins/aiops/public/components/log_categorization/attachments_menu.tsx

+  ]);
+
+  return (
+    <>


nit, this fragment isn't needed

Done in: #d162011

jgowdyelastic · 2024-11-08T13:49:08Z

x-pack/plugins/aiops/public/components/log_categorization/loading_categorization.tsx

@@ -20,9 +20,10 @@ import { FormattedMessage } from '@kbn/i18n-react';

 interface Props {
  onCancel: () => void;
+  disableCancelLoading?: boolean;


rather than passing in an additional prop to disable this, onCancel could be made optional and the button only enabled if onCancel is defined.

Done in: #d162011

jgowdyelastic · 2024-11-08T13:49:25Z

...s/log_categorization/log_categorization_for_embeddable/log_categorization_for_embeddable.tsx

-  const actions = [...getActions(false), ...getActions(true)];
+  const isCasesEmbeddable = embeddingOrigin === AIOPS_EMBEDDABLE_ORIGIN.CASES;
+
+  // Disable filtering for cases embeddable, as it's not possible to delete filters


Suggested change

// Disable filtering for cases embeddable, as it's not possible to delete filters

// When in cases, we can only show the "Filter for pattern in Discover" actions as Cases does not have full filter management.

Done in: #d162011

jgowdyelastic · 2024-11-08T13:49:40Z

...s/log_categorization/log_categorization_for_embeddable/log_categorization_for_embeddable.tsx

+  const isCasesEmbeddable = embeddingOrigin === AIOPS_EMBEDDABLE_ORIGIN.CASES;
+
+  // Disable filtering for cases embeddable, as it's not possible to delete filters
+  const actions = [...(isCasesEmbeddable ? [] : getActions(false)), ...getActions(true)];


nit, I think this is a bit more readable

Suggested change

const actions = [...(isCasesEmbeddable ? [] : getActions(false)), ...getActions(true)];

const actions = isCasesEmbeddable

? getActions(true)

: [...getActions(false), ...getActions(true)];

Done in: #d162011

walterra · 2024-11-11T09:52:17Z

To slightly increase the bundle size for the PR to pass you need to updated the threshold in this file for aiops: packages/kbn-optimizer/limits.yml.

jgowdyelastic

Added a comment about the cancel button, but otherwise LGTM

jgowdyelastic · 2024-11-12T14:57:33Z

...s/log_categorization/log_categorization_for_embeddable/log_categorization_for_embeddable.tsx


  return (
    <>
      <FieldValidationCallout validationResults={fieldValidationResult} />
-      {(loading ?? true) === true ? <LoadingCategorization onCancel={cancelRequest} /> : null}
+      {(loading ?? true) === true ? <LoadingCategorization /> : null}


we still want the ability to cancel the loading when the embeddable is in a dashboard

Done in: 1c4be00

jbudz

packages/kbn-optimizer/limits.yml

adcoelho · 2024-11-13T11:22:30Z

x-pack/plugins/aiops/public/cases/register_cases.tsx

+    displayName: i18n.translate('xpack.aiops.logPatternAnalysis.cases.attachmentName', {
+      defaultMessage: 'Log pattern analysis',
+    }),
+    getAttachmentViewObject: () => ({


It is optional, but you might also want to include a getAttachmentRemovalObject here to define a message for when this attachment is deleted from the case.

elasticmachine · 2024-11-13T11:35:01Z

💚 Build Succeeded

Buildkite Build
Commit: fc51c03

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`aiops`	625	627	+2

Async chunks

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

id	before	after	diff
`aiops`	581.1KB	587.1KB	+6.0KB
`ml`	4.7MB	4.7MB	+21.0B
total			+6.0KB

Page load bundle

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

id	before	after	diff
`aiops`	15.5KB	16.1KB	+641.0B

Unknown metric groups

async chunk count

id	before	after	diff
`aiops`	37	38	+1

History

💔 Build #250677 failed 1c4be00
💚 Build #250171 succeeded 1a073ac
💔 Build #249809 failed d162011
💔 Build #249659 failed f5fdb03
💔 Build #249572 failed dd66350

cc @rbrtj

rbrtj and others added 12 commits November 4, 2024 15:11

add to dashboard and case action for log pattern

84a4e60

styling adjustments

ee37091

functional tests for log pattern attachments

d9e3d7f

remove aiops kibana.jsonc changes

0b8dd60

remove aiops kibana.jsonc changes retry

e2e0e7f

Merge remote-tracking branch 'upstream/main' into aiops-log-analysis-…

f9784b8

…actions

change point detection attach to a case tests

7563821

[CI] Auto-commit changed files from 'node scripts/notice'

515d999

embeddable pattern analysis type

9dae023

update cases api integration tests to include new attachment

88f9dcf

Merge branch 'main' into aiops-log-analysis-actions

38c3b38

resolve conflicts

dd66350

rbrtj commented Nov 8, 2024

View reviewed changes

rbrtj changed the title ~~Aiops log analysis attachments~~ [ML] AiOps: Action for adding Log Pattern embeddable to a dashboard and case Nov 8, 2024

rbrtj self-assigned this Nov 8, 2024

rbrtj added release_note:enhancement :ml v9.0.0 Team:ML Team label for ML (also use :ml) Feature:ML/AIOps ML AIOps features: Change Point Detection, Log Pattern Analysis, Log Rate Analysis backport:version Backport to applied version labels v8.17.0 labels Nov 8, 2024

rbrtj requested review from walterra and jgowdyelastic November 8, 2024 13:43

rbrtj marked this pull request as ready for review November 8, 2024 13:43

rbrtj requested review from a team as code owners November 8, 2024 13:43

rbrtj mentioned this pull request Nov 8, 2024

[ML] Add action for adding log pattern / log rate analysis embeddables to a dashboard or case. #197247

Open

walterra approved these changes Nov 8, 2024

View reviewed changes

jgowdyelastic reviewed Nov 8, 2024

View reviewed changes

rbrtj and others added 4 commits November 8, 2024 17:26

call useAiopsAppContext directly

c696e4e

[CI] Auto-commit changed files from 'node scripts/notice'

085f133

do not treat capabilities as optional

f5fdb03

remove disableCancelLoading props & minor code adjustments

d162011

rbrtj requested a review from jgowdyelastic November 10, 2024 11:19

update aiops bundle size limit

ec2455d

rbrtj requested a review from a team as a code owner November 12, 2024 07:56

Merge branch 'main' into aiops-log-analysis-attachments

1a073ac

jgowdyelastic approved these changes Nov 12, 2024

View reviewed changes

jbudz approved these changes Nov 12, 2024

View reviewed changes

rbrtj and others added 2 commits November 13, 2024 09:12

enable cancel loading button for dashboard embeddable

1c4be00

Merge branch 'main' into aiops-log-analysis-attachments

fc51c03

adcoelho reviewed Nov 13, 2024

View reviewed changes

adcoelho approved these changes Nov 13, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ML] AiOps: Action for adding Log Pattern embeddable to a dashboard and case #199478

[ML] AiOps: Action for adding Log Pattern embeddable to a dashboard and case #199478

rbrtj commented Nov 8, 2024 •

edited

Loading

rbrtj Nov 8, 2024

rbrtj Nov 8, 2024

rbrtj Nov 8, 2024

elasticmachine commented Nov 8, 2024

walterra left a comment

walterra Nov 8, 2024

rbrtj Nov 8, 2024

walterra Nov 8, 2024 •

edited

Loading

rbrtj Nov 8, 2024

walterra Nov 8, 2024

rbrtj Nov 10, 2024

jgowdyelastic Nov 8, 2024

rbrtj Nov 8, 2024

jgowdyelastic Nov 8, 2024

rbrtj Nov 10, 2024

jgowdyelastic Nov 8, 2024

rbrtj Nov 10, 2024

jgowdyelastic Nov 8, 2024

rbrtj Nov 10, 2024

jgowdyelastic Nov 8, 2024

rbrtj Nov 10, 2024

walterra commented Nov 11, 2024

jgowdyelastic left a comment

jgowdyelastic Nov 12, 2024

rbrtj Nov 13, 2024

jbudz left a comment

adcoelho Nov 13, 2024

elasticmachine commented Nov 13, 2024

async chunk count

	// Disable filtering for cases embeddable, as it's not possible to delete filters
	// When in cases, we can only show the "Filter for pattern in Discover" actions as Cases does not have full filter management.

-  const actions = [...(isCasesEmbeddable ? [] : getActions(false)), ...getActions(true)];
+  const actions = isCasesEmbeddable
+    ? getActions(true)
+    : [...getActions(false), ...getActions(true)];

[ML] AiOps: Action for adding Log Pattern embeddable to a dashboard and case #199478

Are you sure you want to change the base?

[ML] AiOps: Action for adding Log Pattern embeddable to a dashboard and case #199478

Conversation

rbrtj commented Nov 8, 2024 • edited Loading

Summary

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Nov 8, 2024

walterra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

walterra Nov 8, 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

walterra commented Nov 11, 2024

jgowdyelastic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jbudz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Nov 13, 2024

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

async chunk count

History

rbrtj commented Nov 8, 2024 •

edited

Loading

walterra Nov 8, 2024 •

edited

Loading