Reporting/diagnostics #74314

joelgriffith · 2020-08-04T22:44:51Z

Summary

Checks successfully:

Checks fail:

Adds a new diagnostic tool to reporting. Currently, this tool checks:

If reporting configuration isn't out of order (no size mismatches between kibana and elasticsearch).
If chromium can startup, and the logs don't contain known defects.
If we can screenshot Kibana properly.

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

…tics

x-pack/plugins/reporting/constants.ts

x-pack/plugins/reporting/server/browsers/chromium/driver_factory/index.ts

x-pack/plugins/reporting/server/lib/index.ts

tsullivan · 2020-08-05T17:34:42Z

Add /diagnose/screenshot API

For an API to test screenshot, I recommend importing generate_png in the route handler and using generatePngObservable.

…tics

joelgriffith · 2020-08-24T22:51:40Z

Screenshot tests (the hardest) are done, moving onto the others + fixing i18n issues.

x-pack/plugins/reporting/server/browsers/chromium/driver_factory/chromium_test.ts

…tics

joelgriffith · 2020-09-08T14:18:28Z

@elasticmachine merge upstream

tsullivan

Need a "no usable sandbox" message

x-pack/plugins/reporting/server/routes/diagnostic/browser.ts

tsullivan · 2020-09-08T21:42:56Z

I tested out this branch with:

building the Kibana linux package: yarn build --no-oss --skip-os-packages
copy the build to a vagrant instance running Centos 7.4 (trying to see a no usable sandbox message)
add no extra packages on top of the base OS

The diagnostic message I got simply stated Browser exited abnormally during startup, but it should have shown a message about the default font not being found.

tsullivan · 2020-09-08T23:12:17Z

docs/user/reporting/reporting-troubleshooting.asciidoc

+[float]
+[[reporting-troubleshooting-diagnostics]]
+=== Reporting Diagnostics
+Reporting comes with a built-in utility to try to automatically find common issues. When Kibana is running, navigate to the Report Listing page, and click the "Run reporting diagnostics..." button. This will open up a diagnostic tool that checks various parts of the Kibana deployment to come up with any relevant recommendations.


Any thoughts or feelings about having the label just be Reporting diagnostics instead of the longer phrase?

tsullivan · 2020-09-08T23:13:06Z

x-pack/plugins/reporting/server/browsers/chromium/driver_factory/start_logs.ts

+
+  // Some chromium errors don't show up until a few seconds after startup
+  // hence why we wait for at least 5 seconds to let them surface
+  const log$ = fromEvent(rl, 'line');


I think it would be great to tap the log lines to logger.info. WDYT?

Yup, that sounds good to me

tsullivan · 2020-09-08T23:26:08Z

Screenshots from my testing:

No default font:

Couldn't detect sandbox:

Not sure how to test the NSS dependency

…tics

joelgriffith · 2020-09-09T18:27:42Z

I had to remove a "log => message" mapping since it printed duplicate messages. Afterwards, this was the message I got when libnss is missing.

x-pack/plugins/reporting/server/browsers/chromium/driver_factory/start_logs.ts

tsullivan · 2020-09-09T21:04:52Z

x-pack/plugins/reporting/server/browsers/chromium/driver_factory/start_logs.ts

+
+  // Some chromium errors don't show up until a few seconds after startup
+  // hence why we wait for at least 5 seconds to let them surface
+  const log$ = fromEvent(rl, 'line').pipe(tap((log) => logger.info(`Chromium log "${log}"`)));


I hate to be picky, but I would like to see this teased out a bit more. What about:

Suggested change

const log$ = fromEvent(rl, 'line').pipe(tap((log) => logger.info(`Chromium log "${log}"`)));

const processLogger = logger.clone(['chromium-stderr']);

const log$ = fromEvent(rl, 'line').pipe(

tap((message: unknown) => {

if (typeof message === 'string') {

processLogger.info(message);

}

})

);

tsullivan

I'd like to check if we have consensus with a wider team on the text of the link label. Let's do that after merge though

LGTM!

kibanamachine · 2020-09-09T23:01:21Z

💚 Build Succeeded

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

Build metrics

@kbn/optimizer bundle module count

id	value	diff	baseline
reporting	45	+1	44

page load bundle size

id	value	diff	baseline
reporting	303.8KB	+13.0KB	290.8KB

distributable file count

id	value	diff	baseline
default	45475	+2	45473

History

💚 Build #73496 succeeded 27ab7c4
💚 Build #73447 succeeded 1c86e84
💚 Build #73263 succeeded 04c9276
💚 Build #73129 succeeded 032442d
💚 Build #72770 succeeded 5cce4f8

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

* WIP: Adding in new reporting diag tool * WIP: chrome-binary test + log capturing/error handling * More wip on diagnostic tool * More work adding in diagnose routes * Alter link in description + minor rename of chrome => browser * Wiring UI to API + some polish on UI flow * WIP: Add in screenshot diag route * Adding in screenshot diag route, hooking up client to it * Add missing lib check + memory check * Working screenshot test + config check for RAM * Small test helper consolidation + screenshot diag test * Delete old i18n translations * PR feedback, browser tests, rename, re-organize import statements and lite fixes * Lite rename for consistency * Remove old validate check i18n * Add config check * i18n all the things! * Docs on diagnostics tool * Fixes, better readability, spelling and more for diagnostic tool * Translate a few error messages * Rename of test => start_logs for clarity. Move to observables * Gathering logs even during process exit or crash * Adds a test case for the browser exiting during the diag check * Tap into browser logs for checking output * Rename asciidoc diag id * Remove duplicate shared object message * Add better comment as to why we merge events + wait for a period of time * Cloning logger for mirroring browser stderr to kibana output Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

* master: (25 commits) [bugfix] Replace panel flyout opens 2 flyouts (elastic#76931) clean up test (elastic#76887) [Enterprise Search] Update shared API request handler (elastic#77112) [Maps] convert ESAggSource to TS (elastic#76999) Add plugin status API - take 2 (elastic#76732) Adds lens as a readable saved object for read-only dashboard users (elastic#77067) Skip checking for the reserved realm (elastic#76687) Reporting/diagnostics (elastic#74314) Reporting/Test: unskip non-screenshot tests (elastic#77088) Move metrics to setup and add cgroup metrics (elastic#76730) [Enterprise Search] Add Overview landing page/plugin (elastic#76734) First pass. Change TS type. Update OpenAPI (elastic#76434) [CI] Balance xpack ci groups a bit (elastic#77068) [Security_solution][Detections] Refactor signal ancestry to allow multiple parents (elastic#76531) [Maps] convert MetricsEditor to TS (elastic#76727) IndexMigrator: fix non blocking migration wrapper promise rejection (elastic#77018) [Enterprise Search] Update config data endpoint to v2 (elastic#76970) [ML] Add decision path charts to exploration results table (elastic#73561) Bump eventemitter3 from 4.0.0 to 4.0.7 (elastic#77016) [Ingest Pipelines] Add descriptions for ingest processors K-S (elastic#76981) ...

* master: (41 commits) [bugfix] Replace panel flyout opens 2 flyouts (elastic#76931) clean up test (elastic#76887) [Enterprise Search] Update shared API request handler (elastic#77112) [Maps] convert ESAggSource to TS (elastic#76999) Add plugin status API - take 2 (elastic#76732) Adds lens as a readable saved object for read-only dashboard users (elastic#77067) Skip checking for the reserved realm (elastic#76687) Reporting/diagnostics (elastic#74314) Reporting/Test: unskip non-screenshot tests (elastic#77088) Move metrics to setup and add cgroup metrics (elastic#76730) [Enterprise Search] Add Overview landing page/plugin (elastic#76734) First pass. Change TS type. Update OpenAPI (elastic#76434) [CI] Balance xpack ci groups a bit (elastic#77068) [Security_solution][Detections] Refactor signal ancestry to allow multiple parents (elastic#76531) [Maps] convert MetricsEditor to TS (elastic#76727) IndexMigrator: fix non blocking migration wrapper promise rejection (elastic#77018) [Enterprise Search] Update config data endpoint to v2 (elastic#76970) [ML] Add decision path charts to exploration results table (elastic#73561) Bump eventemitter3 from 4.0.0 to 4.0.7 (elastic#77016) [Ingest Pipelines] Add descriptions for ingest processors K-S (elastic#76981) ...

…rok/new-patterns-component-use-array * 'master' of github.com:elastic/kibana: (39 commits) [APM] Always load esarchives from common (elastic#77139) [Ingest Manager] Handle Legacy ES client errors (elastic#76865) [Docs] URL Drilldown (elastic#76529) [bugfix] Replace panel flyout opens 2 flyouts (elastic#76931) clean up test (elastic#76887) [Enterprise Search] Update shared API request handler (elastic#77112) [Maps] convert ESAggSource to TS (elastic#76999) Add plugin status API - take 2 (elastic#76732) Adds lens as a readable saved object for read-only dashboard users (elastic#77067) Skip checking for the reserved realm (elastic#76687) Reporting/diagnostics (elastic#74314) Reporting/Test: unskip non-screenshot tests (elastic#77088) Move metrics to setup and add cgroup metrics (elastic#76730) [Enterprise Search] Add Overview landing page/plugin (elastic#76734) First pass. Change TS type. Update OpenAPI (elastic#76434) [CI] Balance xpack ci groups a bit (elastic#77068) [Security_solution][Detections] Refactor signal ancestry to allow multiple parents (elastic#76531) [Maps] convert MetricsEditor to TS (elastic#76727) IndexMigrator: fix non blocking migration wrapper promise rejection (elastic#77018) [Enterprise Search] Update config data endpoint to v2 (elastic#76970) ... # Conflicts: # src/plugins/es_ui_shared/static/forms/hook_form_lib/components/use_array.ts

Joel Griffith added 7 commits July 7, 2020 12:00

WIP: Adding in new reporting diag tool

643d3cd

Merge remote-tracking branch 'upstream/master' into reporting/diagnos…

6ee796a

…tics

WIP: chrome-binary test + log capturing/error handling

ae1a3e6

More wip on diagnostic tool

8bcd274

Merge remote-tracking branch 'upstream/master' into reporting/diagnos…

b10c351

…tics

More work adding in diagnose routes

61fe997

Alter link in description + minor rename of chrome => browser

77ad9c5

joelgriffith requested a review from tsullivan August 4, 2020 22:45

joelgriffith added (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead release_note:enhancement v7.10.0 v8.0.0 labels Aug 4, 2020

tsullivan reviewed Aug 5, 2020

View reviewed changes

x-pack/plugins/reporting/constants.ts Outdated Show resolved Hide resolved

tsullivan reviewed Aug 5, 2020

View reviewed changes

x-pack/plugins/reporting/server/browsers/chromium/driver_factory/index.ts Outdated Show resolved Hide resolved

tsullivan reviewed Aug 5, 2020

View reviewed changes

x-pack/plugins/reporting/server/browsers/chromium/driver_factory/index.ts Outdated Show resolved Hide resolved

tsullivan reviewed Aug 5, 2020

View reviewed changes

x-pack/plugins/reporting/server/lib/index.ts Show resolved Hide resolved

Joel Griffith and others added 10 commits August 5, 2020 13:20

Wiring UI to API + some polish on UI flow

0d434aa

WIP: Add in screenshot diag route

0e661c8

Merge branch 'master' into reporting/diagnostics

a395b42

Adding in screenshot diag route, hooking up client to it

b3131c9

Merge branch 'master' into reporting/diagnostics

5bd3f2f

Merge remote-tracking branch 'upstream/master' into reporting/diagnos…

7f6ac93

…tics

Add missing lib check + memory check

6a03654

Working screenshot test + config check for RAM

09b9e00

Merge remote-tracking branch 'upstream/master' into reporting/diagnos…

f0ead22

…tics

Small test helper consolidation + screenshot diag test

c5aab98

Delete old i18n translations

0cddac1

tsullivan reviewed Aug 25, 2020

View reviewed changes

x-pack/plugins/reporting/server/browsers/chromium/driver_factory/chromium_test.ts Outdated Show resolved Hide resolved

Joel Griffith added 2 commits September 4, 2020 13:57

Merge branch 'master' into reporting/diagnostics

0b8dec0

Merge remote-tracking branch 'upstream/master' into reporting/diagnos…

5cce4f8

…tics

Merge branch 'master' into reporting/diagnostics

032442d

tsullivan requested changes Sep 8, 2020

View reviewed changes

x-pack/plugins/reporting/server/routes/diagnostic/browser.ts Outdated Show resolved Hide resolved

Joel Griffith added 2 commits September 8, 2020 15:25

Gathering logs even during process exit or crash

9200c04

Adds a test case for the browser exiting during the diag check

04c9276

tsullivan reviewed Sep 8, 2020

View reviewed changes

Joel Griffith added 4 commits September 9, 2020 09:02

Tap into browser logs for checking output

c4eecf8

Merge remote-tracking branch 'upstream/master' into reporting/diagnos…

2c54609

…tics

Rename asciidoc diag id

1c86e84

Remove duplicate shared object message

27ab7c4

tsullivan reviewed Sep 9, 2020

View reviewed changes

x-pack/plugins/reporting/server/browsers/chromium/driver_factory/start_logs.ts Outdated Show resolved Hide resolved

Add better comment as to why we merge events + wait for a period of time

902a72b

tsullivan reviewed Sep 9, 2020

View reviewed changes

Cloning logger for mirroring browser stderr to kibana output

fefcfa8

tsullivan approved these changes Sep 9, 2020

View reviewed changes

joelgriffith merged commit 9edb8d9 into elastic:master Sep 9, 2020

joelgriffith mentioned this pull request Sep 9, 2020

[7.x] Reporting/diagnostics (#74314) #77124

Merged

stacey-gammon added the ReleaseStatus Item of high enough importance that it should be called out in release status meetings label Sep 17, 2020

Leaf-Lin mentioned this pull request Sep 25, 2020

Support Diagnostics UI #78531

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reporting/diagnostics #74314

Reporting/diagnostics #74314

joelgriffith commented Aug 4, 2020 •

edited

Loading

tsullivan commented Aug 5, 2020

joelgriffith commented Aug 24, 2020

joelgriffith commented Sep 8, 2020

tsullivan left a comment

tsullivan commented Sep 8, 2020

tsullivan Sep 8, 2020

tsullivan Sep 8, 2020 •

edited

Loading

joelgriffith Sep 9, 2020

tsullivan commented Sep 8, 2020

joelgriffith commented Sep 9, 2020

tsullivan Sep 9, 2020 •

edited

Loading

tsullivan left a comment

kibanamachine commented Sep 9, 2020

-  const log$ = fromEvent(rl, 'line').pipe(tap((log) => logger.info(`Chromium log "${log}"`)));
+    const processLogger = logger.clone(['chromium-stderr']);
+    const log$ = fromEvent(rl, 'line').pipe(
+    tap((message: unknown) => {
+      if (typeof message === 'string') {
+        processLogger.info(message);
+      }
+    })
+  );

Reporting/diagnostics #74314

Reporting/diagnostics #74314

Conversation

joelgriffith commented Aug 4, 2020 • edited Loading

Summary

Checks successfully:

Checks fail:

Checklist

tsullivan commented Aug 5, 2020

joelgriffith commented Aug 24, 2020

joelgriffith commented Sep 8, 2020

tsullivan left a comment

Choose a reason for hiding this comment

tsullivan commented Sep 8, 2020

tsullivan Sep 8, 2020

Choose a reason for hiding this comment

tsullivan Sep 8, 2020 • edited Loading

Choose a reason for hiding this comment

joelgriffith Sep 9, 2020

Choose a reason for hiding this comment

tsullivan commented Sep 8, 2020

joelgriffith commented Sep 9, 2020

tsullivan Sep 9, 2020 • edited Loading

Choose a reason for hiding this comment

tsullivan left a comment

Choose a reason for hiding this comment

kibanamachine commented Sep 9, 2020

💚 Build Succeeded

Build metrics

@kbn/optimizer bundle module count

page load bundle size

distributable file count

History

joelgriffith commented Aug 4, 2020 •

edited

Loading

tsullivan Sep 8, 2020 •

edited

Loading

tsullivan Sep 9, 2020 •

edited

Loading