[Stack Monitoring] Adds optional debug logging for Stack Monitoring #107711
Conversation
8a2726c to
3c407d1
Compare
| RequestHandlerContextMonitoringPlugin, | ||
| } from './types'; | ||
|
|
||
| import { Globals, EndpointTypes } from './static_globals'; | ||
| import { instantiateClient } from './es_client/instantiate_client'; | ||
|
|
||
| // This is used to test the version of kibana | ||
| const snapshotRegex = /-snapshot/i; |
There was a problem hiding this comment.
All the changes above this line are just prettier import reorganization
| @@ -6,53 +6,52 @@ | |||
| */ | |||
There was a problem hiding this comment.
changes at the top of this file are all prettier import reorganization
| requireUIRoutes(this.monitoringCore, { | ||
| if (config.ui.debug_mode) { | ||
| this.log.info('MONITORING DEBUG MODE: ON'); | ||
| } |
There was a problem hiding this comment.
I should add another log line to mention which file it's writing to, if any
| const routes = Object.keys(uiRoutes); | ||
| const server = config.ui.debug_mode |
There was a problem hiding this comment.
Check 1 of 2 to make sure we only decorate this server object if debug_mode is on...
| // bail if the proper config value is not set (extra protection) | ||
| if (!config.ui.debug_mode) { | ||
| return _server; | ||
| } |
There was a problem hiding this comment.
Check 2 of 2 to make sure we ONLY screw around with this server object if debug_mode is turned on...
| // maintain the rest of _server untouched | ||
| ..._server, | ||
| // TODO: replace any | ||
| route: (options: any) => { |
There was a problem hiding this comment.
Maybe replace any with:
type ServerRouteFn = typeof _server.route;
const route: (...args: Parameters<ServerRouteFn>) => ReturnType<ServerRouteFn> = (options) => {
// ...
}
return {
..._server,
route
}| return { | ||
| ...cluster, | ||
| // TODO: better types? | ||
| callWithRequest: async (_req: typeof req, type: string, params: any) => { |
There was a problem hiding this comment.
Are these the same types as Parameters<typeof cluster.callWithRequest>?
|
@elasticmachine merge upstream |
💚 Build SucceededMetrics [docs]
History
To update your PR or re-run it, just comment with: |
💚 Backport successful
This backport PR will be merged automatically after passing CI. |
Summary
Adds two config options:
monitoring.ui.debug_mode: true: (default:false): Whentrue, will log JSON to the Kibana logs representing every query that is run on every pagemonitoring.ui.debug_file_path: <string>(default:''): when set, will write these logs to a file insteadEach ndjson log line will have the following shape:
{ "referer_url": "<the URL of the page that made the request in the UI>", "api_path": "<the API endpoint called>", "query": { "params": <the query executed>, "result": <the ES result> } }If
monitoring.ui.debug_modeisn't set to true, nothing will change. There are two checks to make sure that nothing gets changed unless that flag is set.