[WIP] Expressions caching #51160

ppisljar · 2019-11-20T13:18:38Z

Summary

Adds caching for interpreter:

caching can be disabled for every call at interpretAst
at the time function should be executed we calculate a hash of: input, args, executionContext and fnDef and check the cache for existing result. If we find one we can skip executing this function.
function can have disableCache flag set to true, which will prevent caching of that function

arguments are resolved before this, so using subexpressions, default values etc should work as expected (if subexpression evaluates to the same result it did last time executing the current function can be skipped)

todo:
as timerange which we use in esaggs is in estime format now-90d caching kicks in when we rerun same expression at later time and we don't get new result. For now esaggs function has the disableCache flag set to true. When we refactore esaggs in the future this flag should move to the function that will be generating actual timerange from the estime format

open questions:

how to handle cache expiration and limits

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

This was checked for cross-browser compatibility, including a check against IE11
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
This was checked for keyboard-only and screenreader accessibility

For maintainers

This was checked for breaking API changes and was labeled appropriately
This includes a feature addition or change that requires a release note and was labeled appropriately

elasticmachine · 2019-11-20T13:18:51Z

Pinging @elastic/kibana-app-arch (Team:AppArch)

elasticmachine · 2019-11-20T14:34:16Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: 3d5950b8f309dead8e0820864f38f61774c93407

elasticmachine · 2019-11-26T16:20:09Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: aea64288af85aa9aff192283f221ee337e4a0708

elasticmachine · 2019-11-26T17:01:07Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: dd82b84fd724fbca4470cfe524b845b89fac4846

lukasolson · 2019-11-26T18:30:38Z

src/plugins/expressions/public/interpreter_provider.ts

@@ -37,12 +38,13 @@ export interface InterpreterConfig {
  functions: FunctionsRegistry;
  types: any;
  handlers: any;
+  functionCache: Map<any, any>;


Suggested change

functionCache: Map<any, any>;

functionCache: Map<string, any>;

functionCache: Map<string, unknown>;

I don't know if this will work out, but if it does, it is more restrictive.

streamich

Would be nice to have unit tests for this feature.

lukasolson

Mostly a nit: Can we standardize on a single variable name like disableCache or enableCache and use it as the name for both the variable in the function definition and when invoking the interpreter?

streamich

Also, maybe there is a way to write this in a more modular way and put the caching logic in some separate place. Otherwise, this interpreterProvider function is already too long.

Dosant · 2019-11-27T10:42:45Z

src/plugins/expressions/public/interpreter_provider.ts

+        handlers.getInitialContext(),
+      ]);
+      fnOutput = functionCache.get(hash);
+      if (!fnOutput) {


Possible 0, "", false edge case?
I'd use functionCache.has(hash) to check if there is a cache hit

ppisljar · 2020-01-14T19:20:31Z

Also, maybe there is a way to write this in a more modular way and put the caching logic in some separate place. Otherwise, this interpreterProvider function is already too long.

are you fine for leaving it as is for now, you plan to refactor interpreterProvider anyway ?

streamich · 2020-01-14T21:40:18Z

... you plan to refactor interpreterProvider anyway ?

@ppisljar yes in my branch this interpreterProvider function is all refactored and does not exist anymore, which also means we have huge merge conflicts. I can either add caching in my branch based on the example you have here, or we can merge refactoring first.

ppisljar · 2020-01-14T21:42:13Z

lets merge refactoring first, and lets add caching in separate PR. There is not much of code here so it should not be hard to reimplement in the refactored version.

ppisljar · 2020-02-13T19:15:28Z

updated this on top of refactoring.

ppisljar · 2020-02-14T18:21:45Z

retest

streamich

You have disabled caching from some of the functions maintained in expressions plugin and esaggs, and tsvb. But opting in by default all functions into caching behaviour seems to be a breaking change, as I understand it, or no? For example, shall we also opt-out of caching some of Lens and Canvas functions?

src/plugins/expressions/common/expression_functions/expression_function.ts

src/plugins/expressions/common/expression_functions/types.ts

src/plugins/expressions/common/execution/types.ts

streamich · 2020-02-24T17:33:46Z

src/plugins/expressions/common/execution/types.ts

+  /**
+   * prevents caching in the current execution.
+   */
+  disableCache?: boolean;


Is this something we should expose through execution context to all functions? How would functions use this?

this should already be provided to all functions on the executionContext.

if some function would to do some internal caching (esaggs with make it slow) this would indicate that it should do it.

streamich · 2020-02-24T17:49:54Z

src/plugins/expressions/common/execution/execution.ts

+    const hash = calculateObjectHash([fn, normalizedInput, args, this.context.search]);
+    if (!this.context.disableCache && !fn.disableCache && this.functionCache.has(hash)) {


Maybe we can first check if we have to cache and only then hash.

const doCaching = !this.context.disableCache && !fn.disableCache; if (doCaching) { const hash = calculateObjectHash([fn, normalizedInput, args, this.context.search]); }

src/plugins/expressions/common/execution/execution.ts

LeeDr · 2021-01-07T23:03:14Z

Since we're past 7.11.0 FF, and this isn't a bug fix, should probably bump to 7.12.0.

flash1293 · 2021-04-01T06:56:01Z

@ppisljar This PR is super outdated, did you mean to move it out of draft status or did you want to close it?

kibanamachine · 2021-04-01T07:03:19Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: a94e790
Pipeline Steps (look for red circles / failed steps)
Interpreting CI Failures

Failed CI Steps

Metrics [docs]

‼️ ERROR: no builds found for mergeBase sha [b125472]

History

💔 Build #81250 failed a94e790
💔 Build #28773 failed 471d95155839f2d89a57c0dbdd55c6ddfc0dc6fb
💚 Build #28413 succeeded f3a4677cedf4effee04caa5ced974d8c1d5dd158
💚 Build #27003 succeeded 4fa5fa916d32f5f0abe15e8e59a7065a939bf30a

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

ppisljar · 2021-04-12T12:19:02Z

we implemented request caching on search service which should resolved main needs for which we were thinking about expression caching

ppisljar added the Team:AppArch label Nov 20, 2019

ppisljar force-pushed the expr/caching branch 3 times, most recently from aea6428 to f240fd0 Compare November 26, 2019 15:38

ppisljar marked this pull request as ready for review November 26, 2019 15:38

ppisljar requested a review from a team as a code owner November 26, 2019 15:38

ppisljar added Feature:ExpressionLanguage Interpreter expression language (aka canvas pipeline) review v7.7.0 v8.0.0 labels Nov 26, 2019

ppisljar requested a review from Dosant November 26, 2019 15:39

ppisljar force-pushed the expr/caching branch from f240fd0 to dd82b84 Compare November 26, 2019 15:42

ppisljar requested a review from lukeelmers November 26, 2019 16:16

ppisljar added the release_note:skip Skip the PR/issue when compiling release notes label Nov 26, 2019

lukasolson reviewed Nov 26, 2019

View reviewed changes

streamich reviewed Nov 26, 2019

View reviewed changes

lukasolson reviewed Nov 26, 2019

View reviewed changes

streamich reviewed Nov 26, 2019

View reviewed changes

Dosant reviewed Nov 27, 2019

View reviewed changes

ppisljar changed the title ~~Expr/caching~~ Expressions caching Jan 14, 2020

ppisljar force-pushed the expr/caching branch from dd82b84 to e875a92 Compare January 14, 2020 19:29

streamich mentioned this pull request Jan 14, 2020

Expressions Roadmap #46909

Closed

20 tasks

ppisljar force-pushed the expr/caching branch from e875a92 to b8a163f Compare February 12, 2020 16:06

ppisljar force-pushed the expr/caching branch from b8a163f to 273c3d0 Compare February 13, 2020 19:10

ppisljar force-pushed the expr/caching branch from 273c3d0 to b142a28 Compare February 14, 2020 13:49

ppisljar force-pushed the expr/caching branch from 4fa5fa9 to f3a4677 Compare February 24, 2020 12:05

streamich reviewed Feb 24, 2020

View reviewed changes

spalger added v7.7.1 and removed v7.7.0 labels May 14, 2020

lukeelmers added the WIP Work in progress label Jul 7, 2020

ppisljar added v7.11.0 and removed v7.7.1 labels Jul 21, 2020

ppisljar changed the title ~~Expressions caching~~ [WIP] Expressions caching Jul 30, 2020

interpreter - caching

a94e790

ppisljar force-pushed the expr/caching branch from 471d951 to a94e790 Compare October 13, 2020 07:38

ppisljar removed v7.11.0 review labels Jan 11, 2021

ppisljar requested a review from a team April 1, 2021 01:25

ppisljar closed this Apr 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Expressions caching #51160

[WIP] Expressions caching #51160

ppisljar commented Nov 20, 2019 •

edited

Loading

elasticmachine commented Nov 20, 2019

elasticmachine commented Nov 20, 2019

elasticmachine commented Nov 26, 2019

elasticmachine commented Nov 26, 2019

lukasolson Nov 26, 2019

streamich Feb 24, 2020 •

edited

Loading

streamich left a comment

lukasolson left a comment

streamich left a comment

Dosant Nov 27, 2019

ppisljar commented Jan 14, 2020

streamich commented Jan 14, 2020

ppisljar commented Jan 14, 2020 •

edited

Loading

ppisljar commented Feb 13, 2020

ppisljar commented Feb 14, 2020

streamich left a comment

streamich Feb 24, 2020

ppisljar Feb 25, 2020

streamich Feb 24, 2020

LeeDr commented Jan 7, 2021

flash1293 commented Apr 1, 2021

kibanamachine commented Apr 1, 2021 •

edited

Loading

ppisljar commented Apr 12, 2021

	functionCache: Map<any, any>;
	functionCache: Map<string, any>;

		const hash = calculateObjectHash([fn, normalizedInput, args, this.context.search]);
		if (!this.context.disableCache && !fn.disableCache && this.functionCache.has(hash)) {

[WIP] Expressions caching #51160

[WIP] Expressions caching #51160

Conversation

ppisljar commented Nov 20, 2019 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented Nov 20, 2019

elasticmachine commented Nov 20, 2019

💔 Build Failed

elasticmachine commented Nov 26, 2019

💔 Build Failed

elasticmachine commented Nov 26, 2019

💔 Build Failed

lukasolson Nov 26, 2019

Choose a reason for hiding this comment

streamich Feb 24, 2020 • edited Loading

Choose a reason for hiding this comment

streamich left a comment

Choose a reason for hiding this comment

lukasolson left a comment

Choose a reason for hiding this comment

streamich left a comment

Choose a reason for hiding this comment

Dosant Nov 27, 2019

Choose a reason for hiding this comment

ppisljar commented Jan 14, 2020

streamich commented Jan 14, 2020

ppisljar commented Jan 14, 2020 • edited Loading

ppisljar commented Feb 13, 2020

ppisljar commented Feb 14, 2020

streamich left a comment

Choose a reason for hiding this comment

streamich Feb 24, 2020

Choose a reason for hiding this comment

ppisljar Feb 25, 2020

Choose a reason for hiding this comment

streamich Feb 24, 2020

Choose a reason for hiding this comment

LeeDr commented Jan 7, 2021

flash1293 commented Apr 1, 2021

kibanamachine commented Apr 1, 2021 • edited Loading

💔 Build Failed

Failed CI Steps

Metrics [docs]

History

ppisljar commented Apr 12, 2021

ppisljar commented Nov 20, 2019 •

edited

Loading

streamich Feb 24, 2020 •

edited

Loading

ppisljar commented Jan 14, 2020 •

edited

Loading

kibanamachine commented Apr 1, 2021 •

edited

Loading