[Reporting] Instantiate a logger top level, and use it throughout the job by tsullivan · Pull Request #43636 · elastic/kibana

tsullivan · 2019-08-21T00:41:17Z

Summary

This PR creates jobLogger objects and shares them throughout the job creation flow and job execution flow. This really helps with job execution, because the jobLogger is now tagged with the jobID, which is now logged with every call to the logger. Having the jobID visible for each log line heavily improves logging experiences in Reporting.

server    log   [16:39:26.613] [info][queue-job][reporting] Successfully queued job: jz1w9pmb1hlo89fb5f8ffv8h
server    log   [16:39:26.727] [info][esqueue][reporting][worker] jz1w9l2z1hlo89fb5faeic0i - Claimed job jz1w9pmb1hlo89fb5f8ffv8h
server    log   [16:39:26.728] [info][esqueue][reporting][worker] jz1w9l2z1hlo89fb5faeic0i - Starting job
server    log   [16:39:27.002] [info][execute-job][jz1w9pmb1hlo89fb5f8ffv8h][printable_pdf][reporting] opening url https://spicy.local:443/kbn/app/kibana#/dashboard/49f5cb90-b3f7-11e9-8494-c920836ce301?_g=(refreshInterval%3A(pause%3A!t%2Cvalue%3A0)%2Ctime%3A(from%3Anow-45y%2Fy%2Cto%3Anow))&_a=(description%3A''%2Cfilters%3A!()%2CfullScreenMode%3A!f%2Coptions%3A(hidePanelTitles%3A!f%2CuseMargins%3A!t)%2Cpanels%3A!((embeddableConfig%3A()%2CgridData%3A(h%3A30%2Ci%3A'9fc4caed-0abd-4105-a53f-ff9e1415e350'%2Cw%3A48%2Cx%3A0%2Cy%3A0)%2Cid%3 A'2f8b67b0-b3f7-11e9-8494-c920836ce301'%2CpanelIndex%3A'9fc4caed-0abd-4105-a53f-ff9e1415e350'%2Ctype%3Avisualization%2Cversion%3A'8.0.0')%2C(embeddableConfig%3A()%2CgridData%3A(h%3A17%2Ci%3A'3512b09d-8a0b-4940-a969-71b896a7b216'%2Cw%3A15%2Cx%3A0%2Cy%3A30)%2Cid%3A'7547bb10-ae51-11e9-990d-d1cc7a0af960'%2CpanelIndex%3A'3512b09d-8a0b-4940-a969-71b896a7b216'%2Ctype%3Avisualization%2Cversion%3A'8.0.0')%2C(embeddableConfig%3A()%2CgridData%3A(h%3A17%2Ci%3Ae28befe4-ea77-42f4-acd8-2cacdf1dd9fc%2Cw%3A33%2Cx%3A15%2Cy%3A30)%2Cid%3A'003ecb10-ae51-11e9-990d-d1cc7a0af960'%2CpanelIndex%3Ae28befe4-ea77-42f4-acd8-2cacdf1dd9fc%2Ctype%3Asearch%2Cversion%3A'8.0.0'))%2Cquery%3A(language%3Akuery%2Cquery%3A'')%2CtimeRestore%3A!t%2Ctitle%3ABASHBIOARHY%2CviewMode%3Aview)&forceNow=2019-08-07T23%3A39%3A26.578Z
server    log   [16:39:32.638] [info][execute-job][jz1w9pmb1hlo89fb5f8ffv8h][printable_pdf][reporting] handled 73 page requests
server    log   [16:39:32.864] [info][execute-job][jz1w9pmb1hlo89fb5f8ffv8h][printable_pdf][reporting] found 3 rendered elements in the DOM
server    log   [16:39:34.203] [info][execute-job][jz1w9pmb1hlo89fb5f8ffv8h][printable_pdf][reporting] taking screenshots
server    log   [16:39:35.548] [info][execute-job][jz1w9pmb1hlo89fb5f8ffv8h][printable_pdf][reporting] screenshots taken: 3
server    log   [16:39:36.391] [info][esqueue][reporting][worker] jz1w9l2z1hlo89fb5faeic0i - Job execution completed successfully
server    log   [16:39:36.457] [info][esqueue][reporting][worker] jz1w9l2z1hlo89fb5faeic0i - Job data saved successfully: /.reporting-2019.08.04/_doc/jz1w9pmb1hlo89fb5f8ffv8h

Release Note: Improved the logging for Reporting to include the ID of the current job with every log line. Also, several logging events in Reporting have been raised from debug to info level.

(The last sentence refers to other changes prior to this PR.)

tsullivan · 2019-08-21T01:01:31Z

In order to get control over how things get logged from within the Chromium driver, I decided it's best to NOT pass the logger to the HeadlessChromiumDriver constructor. Logging happens via the caller's logger object that gets passed to each method of the driver.

tsullivan · 2019-08-21T01:03:12Z

Note: removed a redundant tag

tsullivan · 2019-08-21T01:03:36Z

This was causing a redundant tag

elasticmachine · 2019-08-21T02:20:07Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-08-21T18:30:51Z

Pinging @elastic/kibana-stack-services

tsullivan · 2019-08-22T02:00:38Z

Not exactly related to this PR, but this really should have been logged previously.

tsullivan · 2019-08-22T03:02:03Z

It turns out better to not have a logger tied to the instance. Instead, calling code passes in a logger to all the driver methods.

… job

elasticmachine · 2019-08-22T03:05:54Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

…e-typescript-executeJob-ii

elasticmachine · 2019-08-22T22:51:16Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

joelgriffith · 2019-08-23T18:39:07Z

Code LGTM! Nice cleanup

…e-typescript-executeJob-ii

elasticmachine · 2019-08-26T19:29:40Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

bmcconaghy

Code LGTM.

… job (elastic#43636)

… job (#43636) (#44045)

… job (elastic#43636)

tsullivan force-pushed the reporting/more-typescript-executeJob-ii branch from 389b336 to b470782 Compare August 21, 2019 00:56

tsullivan commented Aug 21, 2019

View reviewed changes

Comment thread x-pack/legacy/plugins/reporting/server/lib/esqueue/job.js Outdated

tsullivan Aug 21, 2019

Copy link
Copy Markdown

Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: removed a redundant tag

tsullivan commented Aug 21, 2019

View reviewed changes

Comment thread x-pack/legacy/plugins/reporting/types.d.ts Outdated

tsullivan mentioned this pull request Aug 21, 2019

Reporting/screenshot logging improvements #42898

Closed

tsullivan force-pushed the reporting/more-typescript-executeJob-ii branch 3 times, most recently from c5bf563 to 07c2287 Compare August 21, 2019 01:18

tsullivan added zDeprecated Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead release_note:enhancement Team:Stack Services labels Aug 21, 2019

tsullivan added v7.4.0 v8.0.0 labels Aug 21, 2019

tsullivan commented Aug 22, 2019

View reviewed changes

[Reporting] Instantiate a logger top level, and use it throughout the…

ee58673

… job

tsullivan force-pushed the reporting/more-typescript-executeJob-ii branch from 07c2287 to ee58673 Compare August 22, 2019 03:04

tsullivan requested review from joelgriffith and stacey-gammon and removed request for stacey-gammon August 22, 2019 03:05

tsullivan marked this pull request as ready for review August 22, 2019 03:05

Merge branch 'master' of github.com:elastic/kibana into reporting/mor…

6f318bd

…e-typescript-executeJob-ii

tsullivan requested review from bmcconaghy and chrisdavies August 23, 2019 17:42

joelgriffith approved these changes Aug 23, 2019

View reviewed changes

tsullivan requested a review from a team August 23, 2019 22:42

Merge branch 'master' of github.com:elastic/kibana into reporting/mor…

9ba4cf9

…e-typescript-executeJob-ii

bmcconaghy approved these changes Aug 26, 2019

View reviewed changes

tsullivan merged commit cbc485d into elastic:master Aug 26, 2019

tsullivan deleted the reporting/more-typescript-executeJob-ii branch August 26, 2019 21:33

tsullivan mentioned this pull request Aug 26, 2019

[7.x] [Reporting] Instantiate a logger top level, and use it throughout the job (#43636) #44045

Merged

tsullivan added a commit to tsullivan/kibana that referenced this pull request Aug 26, 2019

[Reporting] Instantiate a logger top level, and use it throughout the…

f4dad1b

… job (elastic#43636)

tsullivan added a commit that referenced this pull request Aug 28, 2019

[Reporting] Instantiate a logger top level, and use it throughout the…

05ef99a

… job (#43636) (#44045)

tsullivan mentioned this pull request Sep 13, 2019

[Reporting] Certain Debug log entries should be promoted to Info #42490

Closed

patrykkopycinski pushed a commit to patrykkopycinski/kibana that referenced this pull request May 6, 2026

[Reporting] Instantiate a logger top level, and use it throughout the…

28a77b1

… job (elastic#43636)

Navigation Menu

Repository navigation

[Reporting] Instantiate a logger top level, and use it throughout the job - #43636

[Reporting] Instantiate a logger top level, and use it throughout the job#43636
tsullivan merged 3 commits into
elastic:masterfrom
tsullivan:reporting/more-typescript-executeJob-ii

tsullivan commented Aug 21, 2019 •

edited

Loading

Uh oh!

tsullivan Aug 21, 2019

Uh oh!

tsullivan Aug 21, 2019

Uh oh!

tsullivan Aug 21, 2019

Uh oh!

Uh oh!

elasticmachine commented Aug 21, 2019

Uh oh!

elasticmachine commented Aug 21, 2019

Uh oh!

tsullivan Aug 22, 2019

Uh oh!

tsullivan Aug 22, 2019

Uh oh!

elasticmachine commented Aug 22, 2019

Uh oh!

elasticmachine commented Aug 22, 2019

Uh oh!

joelgriffith commented Aug 23, 2019

Uh oh!

elasticmachine commented Aug 26, 2019

Uh oh!

bmcconaghy left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

tsullivan commented Aug 21, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

tsullivan Aug 21, 2019

Choose a reason for hiding this comment

Uh oh!

tsullivan Aug 21, 2019

Choose a reason for hiding this comment

Uh oh!

tsullivan Aug 21, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

elasticmachine commented Aug 21, 2019

💚 Build Succeeded

Uh oh!

elasticmachine commented Aug 21, 2019

Uh oh!

tsullivan Aug 22, 2019

Choose a reason for hiding this comment

Uh oh!

tsullivan Aug 22, 2019

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Aug 22, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Aug 22, 2019

💚 Build Succeeded

Uh oh!

joelgriffith commented Aug 23, 2019

Uh oh!

elasticmachine commented Aug 26, 2019

💚 Build Succeeded

Uh oh!

bmcconaghy left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tsullivan commented Aug 21, 2019 •

edited

Loading