[ML] AIOps Log Rate Analysis: improve explanation of log rate spike/dip #186342

alvarezmelissa87 · 2024-06-17T22:43:47Z

Summary

Related issue: #182714

This PR adds a Log rate change column to Log rate analysis results table.

The log rate change is calculated by getting the number of buckets for baseline/deviation using the timerange and interval and then comparing the average rates per bucket for baseline vs deviation.

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
Flaky Test Runner was used on any tests changed
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 · 2024-06-18T22:10:52Z

Pinging @elastic/ml-ui (:ml)

walterra · 2024-06-19T12:45:38Z

.../aiops/public/components/log_rate_analysis_results_table/get_baseline_and_deviation_rates.ts

+        ? `${Math.round((deviationBucketRate / baselineBucketRate) * 100) / 100}x higher`
+        : `${Math.round((baselineBucketRate / deviationBucketRate) * 100) / 100}x lower`


Guess we also need to add i18n to those strings.

Can you use https://github.com/elastic/kibana/blob/main/x-pack/plugins/ml/common/util/metric_change_description.ts for these, as used for the anomalies table? That will use 'More than 100x higher' if the factor is > 100, which is probably appropriate to use here too? Or if you can't call that same code, then use the same rules around precision so that e.g. x14.23 higher becomes x14 higher.

Updated to round and to add localization in ff861eb

walterra · 2024-06-19T12:47:39Z

.../aiops/public/components/log_rate_analysis_results_table/get_baseline_and_deviation_rates.ts

+) {
+  const logRateChange =
+    baselineBucketRate > 0
+      ? analysisType === LOG_RATE_ANALYSIS_TYPE.SPIKE


Our style guide recommends not doing nested ternaries. I'd suggest just using if/else in this function and return early if something matches.

Updated in ff861eb

walterra · 2024-06-19T12:51:10Z

.../aiops/public/components/log_rate_analysis_results_table/log_rate_analysis_results_table.tsx

+  const {
+    analysisType,
+    windowParameters,
+    documentStats: { documentCountStats },
+  } = useAppSelector((s) => s.logRateAnalysis);


Since useColumns is a hook, you could move this inside the hook itself so doesn't need to get passed on as arguments to useColumns.

walterra · 2024-06-19T12:51:22Z

...public/components/log_rate_analysis_results_table/log_rate_analysis_results_table_groups.tsx

+  const {
+    analysisType,
+    windowParameters,
+    documentStats: { documentCountStats },
+  } = useAppSelector((s) => s.logRateAnalysis);


Since useColumns is a hook, you could move this inside the hook itself so doesn't need to get passed on as arguments to useColumns.

Good catch - moved in ff861eb

x-pack/plugins/aiops/public/components/log_rate_analysis_results_table/use_columns.tsx

peteharverson · 2024-06-19T15:42:42Z

x-pack/plugins/aiops/public/components/log_rate_analysis_results_table/use_columns.tsx

+        sortable: false,
+        valign: 'middle',
+      },
+      ['Log rate change']: {


Can the Log rate change column be made sortable? I think the similar column in the anomalies table sorts by size of factor of increase / decrease.

Updated in ff861eb
Since we have the pValue - which is an indication of the impact - I used that to sort 👍

Dosen't look like pValue always correlates to the size of the change.

I think the sortable prop can be ((item: T) => Primitive) as well as a simple boolean and then you can use logic like https://github.com/elastic/kibana/blob/main/x-pack/plugins/ml/server/models/results_service/build_anomaly_table_items.js#L105 to return the factor difference (or maybe you already know the change up front?).

peteharverson · 2024-06-19T15:50:37Z

x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_results.tsx

-  const [skippedColumns, setSkippedColumns] = useState<ColumnNames[]>(['p-value']);
+  const [skippedColumns, setSkippedColumns] = useState<ColumnNames[]>([
+    'p-value',
+    'Baseline rate',


@alvarezmelissa87 @walterra what do you think about showing the Baseline and Deviation rate columns by default, and hiding the Doc count? I like to see these columns in combination with the 'Log rate change' column. Although in the grouped view, Doc count makes sense as the new columns don't have values.

🤔 I think that could work but we'd need all 3 showing up since the groups table and expanded row hare the same column controls. Might need to think about it a bit more if we want to make them independent.

I'm happy to leave it as it is, with baseline and deviation rate hidden by default. The more I think about it, the less I like the idea of adding two extra numeric columns into the table in the default view.

.../aiops/public/components/log_rate_analysis_results_table/get_baseline_and_deviation_rates.ts

peteharverson · 2024-06-19T16:11:28Z

x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_results.tsx

@@ -186,7 +186,11 @@ export const LogRateAnalysisResults: FC<LogRateAnalysisResultsProps> = ({
  );
  const [shouldStart, setShouldStart] = useState(false);
  const [toggleIdSelected, setToggleIdSelected] = useState(resultsGroupedOffId);
-  const [skippedColumns, setSkippedColumns] = useState<ColumnNames[]>(['p-value']);
+  const [skippedColumns, setSkippedColumns] = useState<ColumnNames[]>([


Not related to the changes in this PR, but I think it would be a nice enhancement to persist the user's choice of selected columns to e.g. local storage. I found myself adding in Baseline and Deviation rates for display every time I reran an analysis.

Added as an item to #181111.

alvarezmelissa87 · 2024-06-20T16:07:52Z

@elasticmachine merge upstream

alvarezmelissa87 · 2024-06-20T22:37:05Z

This has been updated and is ready for another look when you get a chance 🙏 cc @peteharverson, @walterra

peteharverson

Gave the latest changes a test. All looks good - only item to look at is the way sorting on the change column works.

.../aiops/public/components/log_rate_analysis_results_table/get_baseline_and_deviation_rates.ts

walterra

Latest changes LGTM.

alvarezmelissa87 · 2024-06-21T19:16:01Z

Gave the latest changes a test. All looks good - only item to look at is the way sorting on the change column works.

Thanks for taking a look, @peteharverson 🙏 Adding sorting for that computed Log rate change is a can of worms as it requires us to make some changes to the custom sorting we've got going on now and will likely require a bit of code churn.
For now, I've removed sorting for that column and added it as a follow up in #181111

…change

peteharverson

Latest changes LGTM

alvarezmelissa87 · 2024-06-24T14:06:05Z

@elasticmachine merge upstream

kibana-ci · 2024-06-24T15:50:48Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: d59e594

Failed CI Steps

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`aiops`	630	631	+1

Async chunks

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

id	before	after	diff
`aiops`	554.2KB	558.7KB	+4.5KB

History

💛 Build #217240 was flaky 51abcd4
💛 Build #217051 was flaky 31ac8ab
💔 Build #217038 failed 37471c4
💔 Build #217005 failed ff861eb
💔 Build #216958 failed 8f0a4ee

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

cc @alvarezmelissa87

add log rate change column

5dac06b

alvarezmelissa87 added release_note:enhancement :ml Feature:ML/AIOps ML AIOps features: Change Point Detection, Log Pattern Analysis, Log Rate Analysis v8.15.0 labels Jun 17, 2024

alvarezmelissa87 self-assigned this Jun 17, 2024

alvarezmelissa87 added 2 commits June 18, 2024 15:54

remove median calculation. calculate rate based on interval and range

ee5e116

fix translation

383fc67

alvarezmelissa87 marked this pull request as ready for review June 18, 2024 22:10

alvarezmelissa87 requested a review from a team as a code owner June 18, 2024 22:10

alvarezmelissa87 requested review from walterra and peteharverson June 18, 2024 22:11

walterra reviewed Jun 19, 2024

View reviewed changes

peteharverson reviewed Jun 19, 2024

View reviewed changes

.../aiops/public/components/log_rate_analysis_results_table/get_baseline_and_deviation_rates.ts Outdated Show resolved Hide resolved

peteharverson reviewed Jun 19, 2024

View reviewed changes

kibanamachine and others added 4 commits June 20, 2024 18:07

Merge branch 'main' into ml-aiops-additional-columns

8f0a4ee

fix translations for log rate message and add sorting

ff861eb

fix log rate calculation for dip

2686407

ensure baseline/deviation rate columns show up for dip

37471c4

update functional tests

31ac8ab

peteharverson reviewed Jun 21, 2024

View reviewed changes

.../aiops/public/components/log_rate_analysis_results_table/get_baseline_and_deviation_rates.ts Outdated Show resolved Hide resolved

walterra approved these changes Jun 21, 2024

View reviewed changes

alvarezmelissa87 mentioned this pull request Jun 21, 2024

[ML] AIOps: 8.15 Log Rate Analysis improvements. #181111

Closed

add singular/plural for translation and remove sorting from log rate …

51abcd4

…change

peteharverson approved these changes Jun 24, 2024

View reviewed changes

Merge branch 'main' into ml-aiops-additional-columns

d59e594

alvarezmelissa87 merged commit 702442d into elastic:main Jun 24, 2024
25 checks passed

kibanamachine added the backport:skip This commit does not require backporting label Jun 24, 2024

alvarezmelissa87 deleted the ml-aiops-additional-columns branch June 24, 2024 16:42

walterra mentioned this pull request Jul 5, 2024

[ML] AIOps: Log Rate Analysis improvements. [meta] [backlog] #187683

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ML] AIOps Log Rate Analysis: improve explanation of log rate spike/dip #186342

[ML] AIOps Log Rate Analysis: improve explanation of log rate spike/dip #186342

alvarezmelissa87 commented Jun 17, 2024 •

edited

Loading

elasticmachine commented Jun 18, 2024

walterra Jun 19, 2024

peteharverson Jun 19, 2024

alvarezmelissa87 Jun 20, 2024

walterra Jun 19, 2024

alvarezmelissa87 Jun 20, 2024

walterra Jun 19, 2024

walterra Jun 19, 2024

alvarezmelissa87 Jun 20, 2024

peteharverson Jun 19, 2024

alvarezmelissa87 Jun 20, 2024

peteharverson Jun 21, 2024

peteharverson Jun 19, 2024 •

edited

Loading

alvarezmelissa87 Jun 20, 2024

peteharverson Jun 21, 2024

peteharverson Jun 19, 2024

peteharverson Jun 19, 2024

alvarezmelissa87 commented Jun 20, 2024

alvarezmelissa87 commented Jun 20, 2024

peteharverson left a comment

walterra left a comment

alvarezmelissa87 commented Jun 21, 2024

peteharverson left a comment

alvarezmelissa87 commented Jun 24, 2024

kibana-ci commented Jun 24, 2024

		? `${Math.round((deviationBucketRate / baselineBucketRate) * 100) / 100}x higher`
		: `${Math.round((baselineBucketRate / deviationBucketRate) * 100) / 100}x lower`

[ML] AIOps Log Rate Analysis: improve explanation of log rate spike/dip #186342

[ML] AIOps Log Rate Analysis: improve explanation of log rate spike/dip #186342

Conversation

alvarezmelissa87 commented Jun 17, 2024 • edited Loading

Summary

Checklist

elasticmachine commented Jun 18, 2024

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

peteharverson Jun 19, 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

alvarezmelissa87 commented Jun 20, 2024

alvarezmelissa87 commented Jun 20, 2024

peteharverson left a comment

Choose a reason for hiding this comment

walterra left a comment

Choose a reason for hiding this comment

alvarezmelissa87 commented Jun 21, 2024

peteharverson left a comment

Choose a reason for hiding this comment

alvarezmelissa87 commented Jun 24, 2024

kibana-ci commented Jun 24, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Module Count

Async chunks

History

alvarezmelissa87 commented Jun 17, 2024 •

edited

Loading

peteharverson Jun 19, 2024 •

edited

Loading