[Lens] Create mathColumn function to improve performance by wylieconlon · Pull Request #101908 · elastic/kibana

wylieconlon · 2021-06-10T14:43:20Z

This is one of the followups needed to improve Lens formula performance. We found unacceptably slow performance when using mapColumn + math in combination, where the total execution time for common cases was several seconds long. By combining this into a single mathColumn function we are able to get consistent performance.

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

elasticmachine · 2021-06-10T14:43:22Z

Pinging @elastic/kibana-app-services (Team:AppServices)

elasticmachine · 2021-06-10T14:43:22Z

Pinging @elastic/kibana-app (Team:KibanaApp)

dej611 · 2021-06-10T14:55:57Z

src/plugins/expressions/common/expression_functions/specs/math_column.ts

+      throw new Error('ID must be unique');
+    }
+
+    const newRows = input.rows.map((row) => {


It would be nice to have this processed in async chunks, in order to give the thread some time to run some small tasks here and there if very big tables are passed.
Lodash exposes a chunks utility for this. What do you think?

flash1293 · 2021-06-14T09:01:21Z

x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/formula.tsx

-                : [],
-            },
-          ],
+          expression: [currentColumn.references.length ? `"${currentColumn.references[0]}"` : ``],


Seems like this is causing the failing test with an empty formula which is annoying - I tried to fix it using staticColumn, but it's missing separate id/name params. We could add those, not sure whether there's a more elegant solution.

The best solution I've found is to use mapColumn with an empty expression.

flash1293 · 2021-06-14T09:06:21Z

src/plugins/expressions/common/expression_functions/specs/math_column.ts

+    const newRows = input.rows.map((row) => {
+      return {
+        ...row,
+        [args.id]: math.fn(


This is still calling math separately for each row which causes the tinymath parser to run many times. If there are a lot of rows, this becomes relevant to performance (~4k rows with a very simple formula - can get worse when multiple math contexts are used for column wise calculations):

I propose we cache the ast by not calling evaluate, but parse, then interpret. This can be done either by pulling the math logic into this expression function so we can simply call parse once, then interpret for every row, or by using memoize-one in the math function on the parse call.

Can be done in a separate PR.

I have added the memoization to tinymath in this PR as it definitely improves the overall speed.

…mance

dej611 · 2021-06-15T10:12:33Z

src/plugins/expressions/common/expression_functions/specs/math_column.ts

+          {
+            expression: args.expression,
+            onError: args.onError,
+          },


This object could be declared on top and reused over and over. Just saving some memory.

I've made also an experiment reusing the same table "template" above, but in terms of performance results were negligible for a medium size table, so not worth the hack.

flash1293

Unsure about the memoization of the parsing, could you check?

flash1293 · 2021-06-15T16:54:08Z

packages/kbn-tinymath/src/index.js


  try {
-    return parseFn(input, options);
+    return memoizeOne(parseFn)(input, options);


Didn't test (I can do tomorrow), but is this actually memoizing? Looking at the memoize-one source code, it seems like memoizeOne itself is not memoized on the passed-in function so it would create a new memoization closure on each call without actually ever hitting the cache.

Looks like the memoizeOne call should be moved outside of the parse function

You're totally right, the memoizeOne function returns a instance each time!

…mance

wylieconlon · 2021-06-15T19:06:25Z

@elasticmachine merge upstream

kibanamachine · 2021-06-15T21:14:03Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`expressions`	156	158	+2

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`expressions`	1469	1495	+26

Any counts in public APIs

Total count of every any typed public API. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats any for more detailed information.

id	before	after	diff
`expressions`	57	58	+1

Async chunks

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

id	before	after	diff
`canvas`	1.3MB	1.3MB	+719.0B
`lens`	1.5MB	1.5MB	-59.0B
total			+660.0B

Page load bundle

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

id	before	after	diff
`expressions`	202.8KB	205.9KB	+3.1KB

Unknown metric groups

API count

id	before	after	diff
`expressions`	1896	1922	+26

History

💔 Build #131461 failed 9d1b40d
💚 Build #131049 succeeded 22f61e9
💔 Build #130502 failed 08121d9

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

ppisljar

code LGTM

flash1293

Tested and parse time as well as overall time spent with doing math went down significantly, LGTM.

There are still optimizations we can do e.g. not having "pass through" mathColumn calls on the root and for things like moving_average(count()) (right now there's a math call to copy the count metric, then the moving_average call, then a math call for copying the moving average result into the final column - we only need the moving_average call). But let's do those separately

) * [Lens] Create mathColumn function to improve performance * Fix empty formula case * Fix tinymath memoization Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

kibanamachine · 2021-06-16T14:38:40Z

💚 Backport successful

Status	Branch	Result
✅	7.x

This backport PR will be merged automatically after passing CI.

…102356) * [Lens] Create mathColumn function to improve performance * Fix empty formula case * Fix tinymath memoization Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Wylie Conlon <william.conlon@elastic.co>

clintandrewhall · 2021-06-17T18:42:58Z

@wylieconlon This PR has broken Canvas Storybook... investigating why with @spalger.

clintandrewhall · 2021-06-17T19:13:27Z

We have a fix-- it originated in the webpack.config of kbn-storybook. I'll include a fix in #101962

[Lens] Create mathColumn function to improve performance

08121d9

wylieconlon requested a review from a team June 10, 2021 14:43

wylieconlon requested a review from a team as a code owner June 10, 2021 14:43

dej611 reviewed Jun 10, 2021

View reviewed changes

flash1293 reviewed Jun 14, 2021

View reviewed changes

wylieconlon added 2 commits June 14, 2021 10:50

Merge remote-tracking branch 'origin/master' into lens/formula-perfor…

517be0e

…mance

Fix empty formula case

22f61e9

wylieconlon requested review from dej611 and flash1293 June 14, 2021 19:03

dej611 reviewed Jun 15, 2021

View reviewed changes

flash1293 reviewed Jun 15, 2021

View reviewed changes

wylieconlon added 2 commits June 15, 2021 13:06

Merge remote-tracking branch 'origin/master' into lens/formula-perfor…

4b65c74

…mance

Fix tinymath memoization

9d1b40d

Merge branch 'master' into lens/formula-performance

c3fe29d

ppisljar approved these changes Jun 16, 2021

View reviewed changes

flash1293 approved these changes Jun 16, 2021

View reviewed changes

wylieconlon added the auto-backport Deprecated - use backport:version if exact versions are needed label Jun 16, 2021

wylieconlon merged commit bdc8740 into elastic:master Jun 16, 2021

wylieconlon deleted the lens/formula-performance branch June 16, 2021 14:35

kibanamachine mentioned this pull request Jun 16, 2021

[7.x] [Lens] Create mathColumn function to improve performance (#101908) #102356

Merged

clintandrewhall added a commit to clintandrewhall/kibana that referenced this pull request Jun 17, 2021

Fix webpack config after changes in elastic#101908

4f5e5b1

Conversation

wylieconlon commented Jun 10, 2021

Checklist

Uh oh!

elasticmachine commented Jun 10, 2021

Uh oh!

elasticmachine commented Jun 10, 2021

Uh oh!

dej611 Jun 10, 2021

Choose a reason for hiding this comment

Uh oh!

flash1293 Jun 14, 2021

Choose a reason for hiding this comment

Uh oh!

wylieconlon Jun 14, 2021

Choose a reason for hiding this comment

Uh oh!

flash1293 Jun 14, 2021

Choose a reason for hiding this comment

Uh oh!

wylieconlon Jun 14, 2021

Choose a reason for hiding this comment

Uh oh!

dej611 Jun 15, 2021

Choose a reason for hiding this comment

Uh oh!

flash1293 left a comment

Choose a reason for hiding this comment

Uh oh!

flash1293 Jun 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wylieconlon Jun 15, 2021

Choose a reason for hiding this comment

Uh oh!

wylieconlon commented Jun 15, 2021

Uh oh!

kibanamachine commented Jun 15, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Any counts in public APIs

Async chunks

Page load bundle

API count

History

Uh oh!

ppisljar left a comment

Choose a reason for hiding this comment

Uh oh!

flash1293 left a comment

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented Jun 16, 2021

💚 Backport successful

Uh oh!

clintandrewhall commented Jun 17, 2021

Uh oh!

clintandrewhall commented Jun 17, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

flash1293 Jun 15, 2021 •

edited

Loading