[ML] Explain log rate spikes: MVP 8.4 improvements.

[walterra]

API

• Return data for mini histograms for the results table as part of the analysis response stream. MUST (WR)
  [ML] Explain log rate spikes: Add field histograms to analysis result. #136295

Overall Page / Navigation / Data Selection / Main Chart

• Technical Preview (or similar tbd) badge for the overall page. MUST (WR)
  [ML] Explain Log Rate Spikes: Adds technical preview badge. #136862
• Display data view name (if set) at top of page, rather than pattern COULD (WR)
  [ML] Explain log rate spikes: Fix data view title. #137053
• Display an error callout when user picks a data view without a time field.
  [ML] Explain log rate spikes: Fix check for time field based data view. #137784
• Add in-page help MUST

Document Count Chart

• Chart: Support stacked bar chart in main doc count chart corresponding to selected table row field value. See the code for the APM Correlations Failed Transactions chart for reference how to do hovering/selection of rows in the results table and pass on that information to the chart. SHOULD (WR)
  [ML] Explain log rate spikes: Split main chart by selected field/value pair. #136712
• When the chart is split by a selected row from the analysis results, the two entities (overall, focus on selected row) are fetched via 2 separate custom hooks. This can lead to race conditions because the two hooks update the DOM independently. SHOULD (WR)
  [ML] Explain log rate spikes: Fix race conditions when loading document count stats. #137715

Search

• Search bar: search/filter functionality will just add the query to whatever request is happening for the count chart MUST (MA)
  [ML] Explain log rate spikes: Search bar. #136571
• Search bar: search/filter functionality will just add the query to whatever request is happening for the analysis MUST (WR)
  [ML] Explain log rate spikes: Split main chart by selected field/value pair. #136712
• Support loading from a saved search MUST (MA)
  [ML] Log rate spike: support saved search #136765

Brushing / Window parameter selection

• If the width of the brush is narrow - presumably less than the width of a bar in the histogram, the selection area overlaying the chart is lost. Is there anything that can be done here? COULD
  [ML] Explain log rate spikes: Fix data out of date when brush selection changes #137791
  [ML] Explain log rate spikes: Use DualBrush component to select WindowParameters for analysis. #136255 (comment)
• If the time range of the page is adjusted, the alignment of the brushes over the selection in the chart is incorrect MUST
  [ML] Explain log rate spikes: Use DualBrush component to select WindowParameters for analysis. #136255 (comment)
  [ML] Explain Log Rate Spikes: Fix stale brush props. #138272
• Display the time range of the brush in a tooltip COULD
  [ML] Explain log rate spikes: Fix brush issues. #138113
• Label selected zones (spike, region to compare) COULD (WR)
  [ML] Explain log rate spikes: Improve analysis workflow. #137192
• On brush selection change - Refresh button copy should make it clear that analysis for table results needs to be re-run
  • Maybe something like Time range selection has changed. Re-run analysis? SHOULD (WR) ([ML] Explain log rate spikes: Fix data out of date when brush selection changes #137791)
• Give the 'Refresh' button which reruns the analysis a different label as there is already a 'Refresh' button for the whole page. Maybe Rerun analysis or just Rerun? MUST (MA)
  • [ML] Explain log rate spikes: adds table sorting #137110
• Add option to clear brush selection SHOULD (WR)
  [ML] Explain log rate spikes: Improve analysis workflow. #137192
• When the selection is on the left hand side of the chart, there is no indication that the baseline range is off the chart COULD ([ML] Explain log rate spikes: Fix data out of date when brush selection changes #137791)
  
• Add “snapping” of the brushes to the chart histogram bar width like this: https://observablehq.com/@d3/brush-snapping COULD ([ML] Explain log rate spikes: Fix data out of date when brush selection changes #137791)

Results table

• Progress bar text should adjust if only 1 pair Progress: 100% — Identified 1 significant field/value pairs. currently displayed COULD (WR)
  [ML] Explain log rates spikes: Fix API messages translations. #137589
• Translate progress messages passed on from the server side to the client. (WR)
  [ML] Explain log rate spikes: Add field histograms to analysis result. #136295 (comment) SHOULD
  [ML] Explain log rates spikes: Fix API messages translations. #137589
• Ascending sorting by p-value in table. MUST (WR)
  [ML] Explain log rate spikes: Add field histograms to analysis result. #136295
• Sort by clicking in column headers COULD (MA)
  • [ML] Explain log rate spikes: adds table sorting #137110
• Info tooltips for the log rate, p-value and impact columns. SHOULD (MA)
  • [ML] Explain log rate spikes: adds table sorting #137110
• Mini stacked bar charts in table column. MUST (WR)
  [ML] Explain log rate spikes: Add field histograms to analysis result. #136295
• Improve 'No data' experience. Do we have the data to show "at least one result" even if the probability is "very low"? If not, enhance the message "No data - select alternative time ranges to compare" COULD (WR)
  [ML] Explain Log Rate Spikes: Fix loading behavior. #137873

Misc

• Error handling (Display errors passed on as streaming actions, e.g. select apm-7.13.2-metric-antifraud-*) MUST (WR)
  [ML] Explain Log Rate Spikes: Fix error handling. #137947
• Document with comment in files where code was duplicated from so we can follow up with moving the files to packages later on. COULD (WR/MA)
  [ML] AIOps Labs: Code consolidation. #136182

Bugs

• Selecting a new data view with no data in the same time range as shown previously - the previous document count chart and total docs are shown, rather than a blank chart MUST:
  
  [ML] Explain log rate spikes: Fix hooks caching. #136645
• Tooltips persist if mouseover on the results table mini histograms while the table is loading MUST (WR)
  Disabled tooltips for now: [ML] Explain log rate spikes: Mini histogram fixes. #137266
• With some data sets / selections, the split in the main chart is different from the table sparkline, e.g. this example with filebeat-apache-2019.01.30 MUST
  (WR)
  [ML] Explain log rate spikes: Mini histogram fixes. #137266
• Table row over / selected style does not give good contrast with font in dark theme MUST
  
  [ML] Explain log rate spikes: Mini histogram fixes. #137266

Tests

• Basic functional tests that assert the overall page
  [ML] Explain Log Rate Spikes: Basic functional tests. #138387
• Extended functional tests that use the brushes and run an analysis
  [ML] Explain Log Rate Spikes: Extended Functional tests. #138661

[elasticmachine]

Pinging @elastic/ml-ui (:ml)