[Reporting] Add context to logging about Space ID handling #80106
Conversation
|
@elasticmachine merge upstream |
tsullivan
added
(Deprecated) Feature:Reporting
|
Pinging @elastic/kibana-app-arch (Team:AppArch) |
| } | ||
| } | ||
| } | ||
|
|
||
| public getFakeRequest(baseRequest: object, spaceId?: string) { | ||
| public getFakeRequest(baseRequest: object, spaceId: string | undefined, logger = this.logger) { |
There was a problem hiding this comment.
Even though a logger is always passed in, I wanted to allow this.logger to be the default since this will now be the only reference to the logger member of the ReportingCore class. If there were no longer references to it, then it should not be declared. However - that process would create churn since we would want to add the logger back in as a member of the class when we need it while registering the task types, in an upcoming PR.
So, it might not seem important to keep the private logger class member, but it helps create a churn of subtractions and additions between different PRs in the code
| return spaceId; | ||
| } else { | ||
| this.logger.info(`Request uses default Space`); | ||
| logger.debug(`Request uses default Space`); |
There was a problem hiding this comment.
I find it better for this recently added log line to be debug rather than info.
tsullivan
changed the title
Co-authored-by: Joel Griffith <[email protected]>
…n/kibana into reporting/logging-context-fixes
💚 Build SucceededMetrics [docs]
History
To update your PR or re-run it, just comment with: |
…0106) * [Reporting] Logger Fixes * info level to debug level for default space message * fix context for custom logo * fix tags * Update x-pack/plugins/reporting/server/core.ts Co-authored-by: Joel Griffith <[email protected]> * rm whitespace * one more backtick string Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Joel Griffith <[email protected]> # Conflicts: # x-pack/plugins/reporting/server/export_types/printable_pdf/create_job/index.ts
…80602) * [Reporting] Logger Fixes * info level to debug level for default space message * fix context for custom logo * fix tags * Update x-pack/plugins/reporting/server/core.ts Co-authored-by: Joel Griffith <[email protected]> * rm whitespace * one more backtick string Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Joel Griffith <[email protected]> # Conflicts: # x-pack/plugins/reporting/server/export_types/printable_pdf/create_job/index.ts
Summary
Problem: after some recent work to bring in better support for Spaces in Reporting, some logging entries are overly-basic due to not having a context of logging tags. To put it more clearly, the logging objects passed through different modules of reporting code carry a "context" of tags to help trace what is happening in the code, using more info than just the log message.
For example, the loggers used during job execution should always have the
exportTypeandjobIDas part of the context.Having this context stay clear at all times will be especially important if Reporting gains an ability to run multiple concurrent jobs.
This PR restores the standard of logging with full context in the Reporting code.
Checklist
Delete any items that are not applicable to this PR.
For maintainers