[ML] AIOps: Renames Explain Log Rate Spikes to Log Rate Analysis. #161764

walterra · 2023-07-12T13:37:52Z

Summary

Part of #161832.

This PR renames the Explain Log Rate Spikes feature to Log Rate Analysis.

Checklist

Unit or functional tests were updated or added to match the most common scenarios
This was checked for breaking API changes and was labeled appropriately

github-actions · 2023-07-12T13:38:07Z

Documentation preview:

✨ Changed pages

…te analysis.

elasticmachine · 2023-07-17T10:50:59Z

Pinging @elastic/ml-ui (:ml)

szabosteve

Thank you for handling all the docs-related changes, too! Docs LGTM!

peteharverson

Apart from the minor comments, LGTM. Gave it a quick test and couldn't see any leftover references to 'Explain Log Rate Spikes'.

peteharverson · 2023-07-17T15:54:47Z

x-pack/plugins/aiops/common/api/log_rate_analysis/schema.ts

@@ -38,4 +38,4 @@ export const aiopsExplainLogRateSpikesSchema = schema.object({
  sampleProbability: schema.maybe(schema.number()),
 });

-export type AiopsExplainLogRateSpikesSchema = TypeOf<typeof aiopsExplainLogRateSpikesSchema>;
+export type AiopsLogRateAnalysisSchema = TypeOf<typeof aiopsLogRateAnalysisSchema>;


Nit - there is a comment in this file which refers to spikes. I assume that info on dips will be stored in it too?

peteharverson · 2023-07-17T15:57:42Z

.../public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content.tsx

@@ -170,7 +170,7 @@ export const ExplainLogRateSpikesContent: FC<ExplainLogRateSpikesContentProps> =
          title={
            <h2>
              <FormattedMessage
-                id="xpack.aiops.explainLogRateSpikesPage.emptyPromptTitle"
+                id="xpack.aiops.logRateAnalysis.page.emptyPromptTitle"
                defaultMessage="Click a spike in the histogram chart to start the analysis."


Did you decide to leave out drop from this one until the functionality for drops is implemented?

peteharverson · 2023-07-17T15:59:00Z

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

@@ -384,7 +383,7 @@ export const ExplainLogRateSpikesAnalysis: FC<ExplainLogRateSpikesAnalysisProps>
          body={
            <p>
              <FormattedMessage
-                id="xpack.aiops.explainLogRateSpikesPage.noResultsPromptBody"
+                id="xpack.aiops.logRateAnalysis.page.noResultsPromptBody"
                defaultMessage="Try to adjust the baseline and deviation time ranges and rerun the analysis. If you still get no results, there might be no statistically significant entities contributing to this spike in log rates."


Are you leaving out drop from this one until the drop functionality is implemented?

walterra · 2023-07-18T05:43:29Z

@peteharverson Thanks for spotting those UI texts, I added a note to the meta issue (#161832) to update them once we add support for drops in the ML plugin page.

benakansara · 2023-07-18T07:16:36Z

x-pack/plugins/observability/common/co_pilot/prompts.ts

-      "Explain Log Rate Spikes" is an AIOps feature that uses advanced statistical methods to identify reasons for increases in log rates. It makes it easy to find and investigate causes of unusual spikes by using the analysis workflow view.
-      You are using "Explain Log Rate Spikes" and ran the statistical analysis on the log messages which occured during the alert.
-      You received the following analysis results from "Explain Log Rate Spikes" which list statistically significant co-occuring field/value combinations sorted from most significant (lower p-values) to least significant (higher p-values) that contribute to the log messages spike:
+      "Log Rate Analysis" is an AIOps feature that uses advanced statistical methods to identify reasons for increases in log rates. It makes it easy to find and investigate causes of unusual spikes by using the analysis workflow view.


@walterra Making a note, we might need to change prompt text once drop functionality is implemented.

Good point, I also added a note to our meta issue regarding drop support: #161832

benakansara

AO changes LGTM

yngrdyn

Changes in x-pack/plugins/serverless_observability/public/components/side_navigation/index.tsx LGTM

kpatticha

Serverless oblt changes LGTM

jgowdyelastic · 2023-07-18T16:41:18Z

x-pack/plugins/aiops/server/routes/log_rate_analysis.ts

@@ -63,23 +63,24 @@ const PROGRESS_STEP_GROUPING = 0.1;
 const PROGRESS_STEP_HISTOGRAMS = 0.1;
 const PROGRESS_STEP_HISTOGRAMS_GROUPS = 0.1;

-export const defineExplainLogRateSpikesRoute = (
+export const defineLogRateAnalysisRoute = (


I don't think having the path passed in to a common route registering function is correct way to do this.
In the future the LOG_RATE_ANALYSIS route will probably change and have its version bumped, and the old route should not change. However as it is now, the old route is the same as the new route and so it will also change versions.

I think the correct way to do this would be to have two completely separate route registrations, and after some time we can delete the deprecated one.

Thinking about this more, I'm now doubting myself.
It probably will be ok to leave as is, as users won't have this server side endpoint bookmarked. But that also makes me wonder if we need to keep the old one around at all during this rename?

In the future, just deleting deprecated code is easier than having to delete and change this function to remove the path variable. So maybe having a completely separate route registrations is cleaner? Even if it is identical code.

As discussed offline, I removed the deprecated API endpoint in a532e49. It was good as a dry run how this might play out in future serverless environments, but it's not necessary to keep the old endpoint around yet since it's internal and experimental.

…og-rate-analysis

jgowdyelastic

LGTM

kibana-ci · 2023-07-19T14:45:10Z

💚 Build Succeeded

Buildkite Build
Commit: 4aef8be

Metrics [docs]

Async chunks

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

id	before	after	diff
`aiops`	834.1KB	834.0KB	-53.0B
`infra`	2.0MB	2.0MB	-21.0B
`ml`	3.4MB	3.4MB	+355.0B
`observability`	1.1MB	1.1MB	-18.0B
total			+263.0B

Page load bundle

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

id	before	after	diff
`aiops`	6.1KB	6.0KB	-61.0B
`ml`	73.7KB	73.8KB	+114.0B
`serverlessObservability`	26.2KB	26.2KB	-6.0B
`serverlessSearch`	29.6KB	29.6KB	-5.0B
total			+42.0B

Unknown metric groups

API count

id	before	after	diff
`aiops`	45	44	-1

History

💔 Build #143526 failed 8bf6f11
💔 Build #143513 failed a532e49
💚 Build #142811 succeeded 041d94b
💔 Build #142806 failed 69e975b
💚 Build #142587 succeeded e60562b0f1730a43f88c595ec574afb456c519dd
💚 Build #142246 succeeded 12e24d558bf6b097c82fea80f87200ca5007631d

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

cc @walterra

…stic#161764) ## Summary Part of elastic#161832. This PR renames the Explain Log Rate Spikes feature to **Log Rate Analysis**. - [x] Renamed references in `docs/developer/*` - [x] Updated docs screenshots - [x] Redirect in docs - [x] Redirect urls from `explain_log_rate_spikes` to `log_rate_analysis` - [x] API versioning - [x] Renamed navigation links - [x] Renamed variable names - [x] Renamed file names - [x] Renamed i18n ids - [x] Renamed breadcrumbs - [x] Removed hard coded `AIOPS_ENABLED` feature flag

walterra self-assigned this Jul 12, 2023

walterra force-pushed the ml-aiops-rename-explain-log-rate-spikes-to-log-rate-analysis branch 2 times, most recently from 3c5678d to 886ae22 Compare July 13, 2023 08:26

walterra mentioned this pull request Jul 13, 2023

[ML] AIOps: Support both spikes and dips for log rate analysis. #161832

Closed

3 tasks

walterra force-pushed the ml-aiops-rename-explain-log-rate-spikes-to-log-rate-analysis branch from bca93e1 to e60562b Compare July 14, 2023 14:12

walterra and others added 14 commits July 17, 2023 09:12

Rename Explain Log Rate Spikes to Log Rate Analysis.

1b7610d

rename i18n ids

e0d3847

fix i18n

3829ea0

update plugin-list

2cd57db

more renaming

9c24f9c

fix image links

a2a7139

fix import

5f8ac68

fix functional tests

ca39565

update docs images

5413e31

[DOCS] Adds redirect to explain log rate spikes that points to log ra…

1cf636c

…te analysis.

Revert spaces in index.asciidoc

5523f66

keep previous API endpoint around

faebe16

remove hard-coded AIOPS_ENABLED feature flag

023ac2d

redirect UI routes

69e975b

walterra force-pushed the ml-aiops-rename-explain-log-rate-spikes-to-log-rate-analysis branch from e60562b to 69e975b Compare July 17, 2023 09:12

walterra added :ml v8.10.0 Feature:ML/AIOps ML AIOps features: Change Point Detection, Log Pattern Analysis, Log Rate Analysis labels Jul 17, 2023

fix imports

041d94b

walterra marked this pull request as ready for review July 17, 2023 10:50

walterra requested review from a team as code owners July 17, 2023 10:50

walterra requested review from peteharverson and jgowdyelastic July 17, 2023 10:51

walterra added the release_note:enhancement label Jul 17, 2023

walterra requested review from alvarezmelissa87 and szabosteve July 17, 2023 10:57

szabosteve approved these changes Jul 17, 2023

View reviewed changes

peteharverson approved these changes Jul 17, 2023

View reviewed changes

benakansara reviewed Jul 18, 2023

View reviewed changes

benakansara approved these changes Jul 18, 2023

View reviewed changes

yngrdyn approved these changes Jul 18, 2023

View reviewed changes

kpatticha approved these changes Jul 18, 2023

View reviewed changes

rshen91 approved these changes Jul 18, 2023

View reviewed changes

jgowdyelastic reviewed Jul 18, 2023

View reviewed changes

walterra added 2 commits July 19, 2023 13:59

Merge branch 'main' into ml-aiops-rename-explain-log-rate-spikes-to-l…

99429b4

…og-rate-analysis

remove deprecated API endpoint

a532e49

jgowdyelastic approved these changes Jul 19, 2023

View reviewed changes

walterra added 2 commits July 19, 2023 14:47

fix merge conflict

8bf6f11

fix snapshot

4aef8be

walterra merged commit 11cc1e1 into elastic:main Jul 19, 2023

kibanamachine added the backport:skip This commit does not require backporting label Jul 19, 2023

walterra deleted the ml-aiops-rename-explain-log-rate-spikes-to-log-rate-analysis branch July 19, 2023 14:46

peteharverson changed the title ~~[ML] AIOps: Rename Explain Log Rate Spikes to Log Rate Analysis.~~ [ML] AIOps: Renames Explain Log Rate Spikes to Log Rate Analysis. Aug 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ML] AIOps: Renames Explain Log Rate Spikes to Log Rate Analysis. #161764

[ML] AIOps: Renames Explain Log Rate Spikes to Log Rate Analysis. #161764

walterra commented Jul 12, 2023 •

edited

Loading

github-actions bot commented Jul 12, 2023

elasticmachine commented Jul 17, 2023

szabosteve left a comment

peteharverson left a comment

peteharverson Jul 17, 2023

peteharverson Jul 17, 2023

peteharverson Jul 17, 2023

walterra commented Jul 18, 2023

benakansara Jul 18, 2023

walterra Jul 18, 2023

benakansara left a comment •

edited

Loading

yngrdyn left a comment

kpatticha left a comment

jgowdyelastic Jul 18, 2023 •

edited

Loading

jgowdyelastic Jul 18, 2023 •

edited

Loading

walterra Jul 19, 2023

jgowdyelastic left a comment

kibana-ci commented Jul 19, 2023

API count

[ML] AIOps: Renames Explain Log Rate Spikes to Log Rate Analysis. #161764

[ML] AIOps: Renames Explain Log Rate Spikes to Log Rate Analysis. #161764

Conversation

walterra commented Jul 12, 2023 • edited Loading

Summary

Checklist

github-actions bot commented Jul 12, 2023

elasticmachine commented Jul 17, 2023

szabosteve left a comment

Choose a reason for hiding this comment

peteharverson left a comment

Choose a reason for hiding this comment

peteharverson Jul 17, 2023

Choose a reason for hiding this comment

peteharverson Jul 17, 2023

Choose a reason for hiding this comment

peteharverson Jul 17, 2023

Choose a reason for hiding this comment

walterra commented Jul 18, 2023

benakansara Jul 18, 2023

Choose a reason for hiding this comment

walterra Jul 18, 2023

Choose a reason for hiding this comment

benakansara left a comment • edited Loading

Choose a reason for hiding this comment

yngrdyn left a comment

Choose a reason for hiding this comment

kpatticha left a comment

Choose a reason for hiding this comment

jgowdyelastic Jul 18, 2023 • edited Loading

Choose a reason for hiding this comment

jgowdyelastic Jul 18, 2023 • edited Loading

Choose a reason for hiding this comment

walterra Jul 19, 2023

Choose a reason for hiding this comment

jgowdyelastic left a comment

Choose a reason for hiding this comment

kibana-ci commented Jul 19, 2023

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

API count

History

walterra commented Jul 12, 2023 •

edited

Loading

benakansara left a comment •

edited

Loading

jgowdyelastic Jul 18, 2023 •

edited

Loading

jgowdyelastic Jul 18, 2023 •

edited

Loading