Link code for "Kibana server is not ready yet" to related doc (#241345)

Resolves [issue](#158518)

## Summary
Adding the respective troubleshooting document link to our logs for the
"Kibana server is not ready yet" error. This helps the support team by
having a possible decrease in tickets where customers are able to do
some troubleshooting before opening a ticket and better SDHs as the
support team would work through the troubleshooting docs prior to
opening the SDH.

Related doc being referenced in the ticket:
https://www.elastic.co/docs/troubleshoot/kibana/error-server-not-ready

---------

Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>

Author: 3 people

src/core/packages/doc-links/server/index.ts

@@ -7,4 +7,8 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-export type { DocLinksServiceStart, DocLinksServiceSetup } from './src/types';
+export type {
+  DocLinksServiceStart,
+  DocLinksServiceSetup,
+  DocLinksServicePreboot,
+} from './src/types';

src/core/packages/doc-links/server/src/types.ts

@@ -21,3 +21,6 @@ export interface DocLinksServiceSetup {
 
 /** @public */
 export type DocLinksServiceStart = DocLinksServiceSetup;
+
+/** @public */
+export type DocLinksServicePreboot = DocLinksServiceSetup;

src/core/packages/http/server-internal/src/http_service.test.ts

@@ -18,6 +18,7 @@ import { getEnvOptions } from '@kbn/config-mocks';
 import { loggingSystemMock } from '@kbn/core-logging-server-mocks';
 import { executionContextServiceMock } from '@kbn/core-execution-context-server-mocks';
 import { contextServiceMock } from '@kbn/core-http-context-server-mocks';
+import { docLinksServiceMock } from '@kbn/core-doc-links-server-mocks';
 import { Router } from '@kbn/core-http-router-server-internal';
 jest.mock('@kbn/core-http-router-server-internal');
 import { HttpService } from './http_service';
@@ -51,8 +52,11 @@ const createConfigService = (value: Partial<HttpConfigType> = {}) => {
 const contextPreboot = contextServiceMock.createPrebootContract();
 const contextSetup = contextServiceMock.createSetupContract();
 
+const docLinksPreboot = docLinksServiceMock.createSetupContract();
+
 const prebootDeps = {
   context: contextPreboot,
+  docLinks: docLinksPreboot,
 };
 const setupDeps = {
   context: contextSetup,

src/core/packages/http/server-internal/src/http_service.ts

@@ -33,6 +33,7 @@ import type {
   InternalContextSetup,
   InternalContextPreboot,
 } from '@kbn/core-http-context-server-internal';
+import type { DocLinksServicePreboot } from '@kbn/core-doc-links-server';
 import type { RouterOptions } from '@kbn/core-http-router-server-internal';
 import { Router } from '@kbn/core-http-router-server-internal';
 
@@ -56,6 +57,7 @@ import { externalUrlConfig, ExternalUrlConfig } from './external_url';
 
 export interface PrebootDeps {
   context: InternalContextPreboot;
+  docLinks: DocLinksServicePreboot;
 }
 
 export interface SetupDeps {
@@ -105,6 +107,7 @@ export class HttpService
 
   public async preboot(deps: PrebootDeps): Promise<InternalHttpServicePreboot> {
     this.log.debug('setting up preboot server');
+
     const config = await firstValueFrom(this.config$);
 
     const prebootSetup = await this.prebootServer.setup({
@@ -114,7 +117,9 @@ export class HttpService
       path: '/{p*}',
       method: '*',
       handler: (req, responseToolkit) => {
-        this.log.debug(`Kibana server is not ready yet ${req.method}:${req.url.href}.`);
+        this.log.debug(
+          `Kibana server is not ready yet ${req.method}:${req.url.href}. For troubleshooting guidance, see ${deps.docLinks.links.server.troubleshootServerNotReady}`
+        );
 
         // If server is not ready yet, because plugins or core can perform
         // long running tasks (build assets, saved objects migrations etc.)

src/core/packages/http/server-internal/tsconfig.json

@@ -35,6 +35,8 @@
     "@kbn/logging-mocks",
     "@kbn/router-to-openapispec",
     "@kbn/core-base-server-mocks",
+    "@kbn/core-doc-links-server",
+    "@kbn/core-doc-links-server-mocks",
   ],
   "exclude": [
     "target/**/*",

src/core/packages/http/server-mocks/src/test_utils.ts

@@ -15,6 +15,7 @@ import { Env } from '@kbn/config';
 import { getEnvOptions, configServiceMock } from '@kbn/config-mocks';
 import type { CoreContext } from '@kbn/core-base-server-internal';
 import { contextServiceMock } from '@kbn/core-http-context-server-mocks';
+import { docLinksServiceMock } from '@kbn/core-doc-links-server-mocks';
 import { executionContextServiceMock } from '@kbn/core-execution-context-server-mocks';
 import { loggingSystemMock } from '@kbn/core-logging-server-mocks';
 import type { IRouter } from '@kbn/core-http-server';
@@ -169,6 +170,7 @@ export const createHttpService = (): HttpIntegrationTestService => {
     preboot: async () => {
       await svc.preboot({
         context: contextServiceMock.createPrebootContract(),
+        docLinks: docLinksServiceMock.createSetupContract(),
       });
     },
     setup: () => {

src/core/packages/http/server-mocks/tsconfig.json

@@ -25,6 +25,7 @@
     "@kbn/core-http-context-server-mocks",
     "@kbn/core-execution-context-server-mocks",
     "@kbn/lazy-object",
+    "@kbn/core-doc-links-server-mocks",
   ],
   "exclude": [
     "target/**/*",

src/core/packages/root/server-internal/src/server.test.ts

@@ -87,6 +87,7 @@ test('preboot services on "preboot"', async () => {
   expect(mockContextService.preboot).not.toHaveBeenCalled();
   expect(mockHttpService.preboot).not.toHaveBeenCalled();
   expect(mockI18nService.preboot).not.toHaveBeenCalled();
+  expect(mockDocLinksService.setup).not.toHaveBeenCalled();
   expect(mockElasticsearchService.preboot).not.toHaveBeenCalled();
   expect(mockUiSettingsService.preboot).not.toHaveBeenCalled();
   expect(mockRenderingService.preboot).not.toHaveBeenCalled();
@@ -102,6 +103,7 @@ test('preboot services on "preboot"', async () => {
   expect(mockContextService.preboot).toHaveBeenCalledTimes(1);
   expect(mockHttpService.preboot).toHaveBeenCalledTimes(1);
   expect(mockI18nService.preboot).toHaveBeenCalledTimes(1);
+  expect(mockDocLinksService.setup).toHaveBeenCalledTimes(1);
   expect(mockElasticsearchService.preboot).toHaveBeenCalledTimes(1);
   expect(mockUiSettingsService.preboot).toHaveBeenCalledTimes(1);
   expect(mockRenderingService.preboot).toHaveBeenCalledTimes(1);
@@ -128,7 +130,6 @@ test('sets up services on "setup"', async () => {
   expect(mockLoggingService.setup).not.toHaveBeenCalled();
   expect(mockI18nService.setup).not.toHaveBeenCalled();
   expect(mockDeprecationService.setup).not.toHaveBeenCalled();
-  expect(mockDocLinksService.setup).not.toHaveBeenCalled();
   expect(mockCustomBrandingService.setup).not.toHaveBeenCalled();
   expect(mockUserSettingsService.setup).not.toHaveBeenCalled();
   expect(mockSecurityService.setup).not.toHaveBeenCalled();
@@ -150,7 +151,7 @@ test('sets up services on "setup"', async () => {
   expect(mockLoggingService.setup).toHaveBeenCalledTimes(1);
   expect(mockI18nService.setup).toHaveBeenCalledTimes(1);
   expect(mockDeprecationService.setup).toHaveBeenCalledTimes(1);
-  expect(mockDocLinksService.setup).toHaveBeenCalledTimes(1);
+  expect(mockDocLinksService.setup).toHaveBeenCalledTimes(2);
   expect(mockCustomBrandingService.setup).toHaveBeenCalledTimes(1);
   expect(mockUserSettingsService.setup).toHaveBeenCalledTimes(1);
   expect(mockSecurityService.setup).toHaveBeenCalledTimes(1);

src/core/packages/root/server-internal/src/server.ts

@@ -210,8 +210,12 @@ export class Server {
       const contextServicePreboot = this.context.preboot({
         pluginDependencies: new Map([...pluginTree.asOpaqueIds]),
       });
+      const docLinksPreboot = this.docLinks.setup();
 
-      const httpPreboot = await this.http.preboot({ context: contextServicePreboot });
+      const httpPreboot = await this.http.preboot({
+        context: contextServicePreboot,
+        docLinks: docLinksPreboot,
+      });
 
       // setup i18n prior to any other service, to have translations ready
       const i18nPreboot = await this.i18n.preboot({ http: httpPreboot, pluginPaths });

src/core/packages/test-helpers/test-utils/src/setup_server.ts

@@ -18,6 +18,7 @@ import { savedObjectsServiceMock } from '@kbn/core-saved-objects-server-mocks';
 import { elasticsearchServiceMock } from '@kbn/core-elasticsearch-server-mocks';
 import { uiSettingsServiceMock } from '@kbn/core-ui-settings-server-mocks';
 import { deprecationsServiceMock } from '@kbn/core-deprecations-server-mocks';
+import { docLinksServiceMock } from '@kbn/core-doc-links-server-mocks';
 
 const defaultCoreId = Symbol('core');
 
@@ -45,7 +46,10 @@ export const setupServer = async (coreId: symbol = defaultCoreId) => {
   const coreContext = createCoreContext({ coreId });
   const contextService = new ContextService(coreContext);
   const server = new HttpService(coreContext);
-  await server.preboot({ context: contextServiceMock.createPrebootContract() });
+  await server.preboot({
+    context: contextServiceMock.createPrebootContract(),
+    docLinks: docLinksServiceMock.createSetupContract(),
+  });
   const httpSetup = await server.setup({
     context: contextService.setup({ pluginDependencies: new Map() }),
     executionContext: executionContextServiceMock.createInternalSetupContract(),