[Enterprise Search] Log warning for Kibana/EntSearch version mismatches #100809

cee-chen · 2021-05-27T18:06:53Z

Summary

Adds a small Kibana log warning whenever Enterprise Search polls the config data endpoint (e.g. for access check, on plugin load) and warns if versions are mismatched.

We should always see this on dev since Kibana's master is 8.0.0 and Ent Search's is 7.x:

Checklist

FYI, no i18n for log messages is required from my last recollection of asking this question.

Unit or functional tests were updated or added to match the most common scenarios

…s are mismatched

cee-chen · 2021-05-27T18:07:46Z

x-pack/plugins/enterprise_search/server/lib/enterprise_search_config_api.ts

@@ -135,3 +139,13 @@ export const callEnterpriseSearchConfigAPI = async ({
    clearTimeout(timeout);
  }
 };
+
+export const warnMismatchedVersions = (enterpriseSearchVersion: string, log: Logger) => {


I was 50/50 about pulling this out to a separate helper const vs. keeping it inline in the main fn, but I figured there was enough complex logic going on in the main fn (timeouts, etc.) that it was a little nicer to pull this out to its own thing 🤔 If you feel strongly otherwise though I can change it, LMK

x-pack/plugins/enterprise_search/server/lib/enterprise_search_config_api.ts

kibanamachine · 2021-05-27T23:38:32Z

💚 Build Succeeded

Metrics [docs]

Unknown metric groups

References to deprecated APIs

id	before	after	diff
`canvas`	29	25	-4
`crossClusterReplication`	8	6	-2
`fleet`	22	20	-2
`globalSearch`	4	2	-2
`indexManagement`	12	7	-5
`infra`	261	149	-112
`lens`	67	45	-22
`licensing`	18	15	-3
`lists`	239	236	-3
`maps`	286	208	-78
`ml`	121	115	-6
`monitoring`	109	56	-53
`securitySolution`	386	342	-44
`stackAlerts`	101	95	-6
total			-342

History

💚 Build #127738 succeeded e1277da

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

byronhulcher

Code-wise this looks fine to me, but I'm not sure I understand how often this log message will appear for a user. I can think of a few SDH issues that were somewhat complicated by noisy but ultimately benign error messages we had to filter out. Just want to validate that this will is the right time/place/rate for this message to encourage them to resolve the version mismatch

cee-chen · 2021-05-28T17:19:37Z

Simplified explanation, but it essentially happens primarily "on load" and that's it.

We call callEnterpriseSearchConfigAPI for two things:

On initial Kibana load/visit, to check whether the user has access to App Search/Workplace Search (and disable the plugin if not)
On initial Enterprise Search plugin load/visit (any of the 3 plugins - navigating between Enterprise Search plugins does not trigger a new call, navigating out to (e.g.) Observability and then back to Enterprise Search will re-trigger). This call grabs the initial app data that we used to hydrate our React apps with on load.

It should not re-log after that. I don't anticipate this being a noisy log especially for users that primarily stay on Enterprise Search. It has the same conditions as the "timeout warnings" which the Kibana team/security team told us to put in so at the very minimum it won't be noisier than that :)

cee-chen · 2021-05-28T17:21:40Z

Oh, I should add the two logs in a row in the PR screenshot was me deliberately hard refreshing the page to test if the logs were working.

byronhulcher

Simplified explanation, but it essentially happens primarily "on load" and that's it.

👍

Oh, I should add the two logs in a row in the PR screenshot was me deliberately hard refreshing the page to test if the logs were working.

That was, admittedly, what sparked my curiosity.

Merge on @constancecchen

…es (elastic#100809) * Add server log warnings whenever Kibana and Enterprise Search versions are mismatched * Copy feedback

kibanamachine · 2021-05-28T17:59:51Z

💚 Backport successful

Status	Branch	Result
✅	7.x

This backport PR will be merged automatically after passing CI.

* master: (77 commits) [RAC][Security Solution] Register Security Detection Rules with Rule Registry (elastic#96015) [Enterprise Search] Log warning for Kibana/EntSearch version mismatches (elastic#100809) updating the saved objects test to include more saved object types (elastic#100828) [ML] Fix categorization job view examples link when datafeed uses multiple indices (elastic#100789) Fixing ES archive mapping failure (elastic#100835) Fix bug with Observability > APM header navigation (elastic#100845) [Security Solution][Endpoint] Add event filters summary card to the fleet endpoint tab (elastic#100668) [Actions] Taking space id into account when creating email footer link (elastic#100734) Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (elastic#100823) [Security Solution] Improve find rule and find rule status route performance (elastic#99678) [DOCS] Adds video to introduction (elastic#100906) [Fleet] Improve combo box for fleet settings (elastic#100603) [Security Solution][Endpoint] Endpoint generator and data loader support for Host Isolation (elastic#100813) [DOCS] Adds Lens video (elastic#100898) [TSVB] [Table tab] Fix "Math" aggregation (elastic#100765) chore(NA): moving @kbn/io-ts-utils into bazel (elastic#100810) [Alerting] Adding feature flag for enabling/disabling rule import and export (elastic#100718) [TSVB] Fix Upgrading from 7.12.1 to 7.13.0 breaks TSVB (elastic#100864) [Lens] Adds dynamic table cell coloring (elastic#95217) [Security Solution][Endpoint] Do not display searchbar in security-trusted apps if there are no items (elastic#100853) ...

…es (#100809) (#100935) * Add server log warnings whenever Kibana and Enterprise Search versions are mismatched * Copy feedback Co-authored-by: Constance <[email protected]>

Add server log warnings whenever Kibana and Enterprise Search version…

e1277da

…s are mismatched

cee-chen added Feature:Plugins release_note:skip Skip the PR/issue when compiling release notes v7.14.0 auto-backport Deprecated - use backport:version if exact versions are needed labels May 27, 2021

cee-chen requested a review from a team May 27, 2021 18:06

cee-chen commented May 27, 2021

View reviewed changes

x-pack/plugins/enterprise_search/server/lib/enterprise_search_config_api.ts Outdated Show resolved Hide resolved

Copy feedback

1aeaf80

byronhulcher reviewed May 28, 2021

View reviewed changes

byronhulcher approved these changes May 28, 2021

View reviewed changes

cee-chen merged commit 8529040 into elastic:master May 28, 2021

cee-chen deleted the log-ent-search-version-mismatch branch May 28, 2021 17:57

kibanamachine mentioned this pull request May 28, 2021

[7.x] [Enterprise Search] Log warning for Kibana/EntSearch version mismatches (#100809) #100935

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Enterprise Search] Log warning for Kibana/EntSearch version mismatches #100809

[Enterprise Search] Log warning for Kibana/EntSearch version mismatches #100809

cee-chen commented May 27, 2021

cee-chen May 27, 2021 •

edited

Loading

kibanamachine commented May 27, 2021

References to deprecated APIs

byronhulcher left a comment

cee-chen commented May 28, 2021 •

edited

Loading

cee-chen commented May 28, 2021

byronhulcher left a comment

kibanamachine commented May 28, 2021

[Enterprise Search] Log warning for Kibana/EntSearch version mismatches #100809

[Enterprise Search] Log warning for Kibana/EntSearch version mismatches #100809

Conversation

cee-chen commented May 27, 2021

Summary

Checklist

cee-chen May 27, 2021 • edited Loading

Choose a reason for hiding this comment

kibanamachine commented May 27, 2021

💚 Build Succeeded

Metrics [docs]

References to deprecated APIs

History

byronhulcher left a comment

Choose a reason for hiding this comment

cee-chen commented May 28, 2021 • edited Loading

cee-chen commented May 28, 2021

byronhulcher left a comment

Choose a reason for hiding this comment

kibanamachine commented May 28, 2021

💚 Backport successful

cee-chen May 27, 2021 •

edited

Loading

cee-chen commented May 28, 2021 •

edited

Loading