Deprecate and remove usages of elasticsearch.logQueries (#89296)

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
elastic · Feb 1, 2021 · 19332c0 · 19332c0
1 parent 57453f1
commit 19332c0
Show file tree

Hide file tree

Showing 23 changed files with 216 additions and 335 deletions.
diff --git a/.../development/core/server/kibana-plugin-core-server.elasticsearchclientconfig.md b/.../development/core/server/kibana-plugin-core-server.elasticsearchclientconfig.md
@@ -9,7 +9,7 @@ Configuration options to be used to create a [cluster client](./kibana-plugin-co
 <b>Signature:</b>
 
 ```typescript
-export declare type ElasticsearchClientConfig = Pick<ElasticsearchConfig, 'customHeaders' | 'logQueries' | 'sniffOnStart' | 'sniffOnConnectionFault' | 'requestHeadersWhitelist' | 'sniffInterval' | 'hosts' | 'username' | 'password'> & {
+export declare type ElasticsearchClientConfig = Pick<ElasticsearchConfig, 'customHeaders' | 'sniffOnStart' | 'sniffOnConnectionFault' | 'requestHeadersWhitelist' | 'sniffInterval' | 'hosts' | 'username' | 'password'> & {
     pingTimeout?: ElasticsearchConfig['pingTimeout'] | ClientOptions['pingTimeout'];
     requestTimeout?: ElasticsearchConfig['requestTimeout'] | ClientOptions['requestTimeout'];
     ssl?: Partial<ElasticsearchConfig['ssl']>;

diff --git a/...lopment/core/server/kibana-plugin-core-server.elasticsearchconfig.logqueries.md b/...lopment/core/server/kibana-plugin-core-server.elasticsearchconfig.logqueries.md
diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.md
@@ -27,7 +27,6 @@ export declare class ElasticsearchConfig
 |  [healthCheckDelay](./kibana-plugin-core-server.elasticsearchconfig.healthcheckdelay.md) |  | <code>Duration</code> | The interval between health check requests Kibana sends to the Elasticsearch. |
 |  [hosts](./kibana-plugin-core-server.elasticsearchconfig.hosts.md) |  | <code>string[]</code> | Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster. |
 |  [ignoreVersionMismatch](./kibana-plugin-core-server.elasticsearchconfig.ignoreversionmismatch.md) |  | <code>boolean</code> | Whether to allow kibana to connect to a non-compatible elasticsearch node. |
-|  [logQueries](./kibana-plugin-core-server.elasticsearchconfig.logqueries.md) |  | <code>boolean</code> | Specifies whether all queries to the client should be logged (status code, method, query etc.). |
 |  [password](./kibana-plugin-core-server.elasticsearchconfig.password.md) |  | <code>string</code> | If Elasticsearch is protected with basic authentication, this setting provides the password that the Kibana server uses to perform its administrative functions. |
 |  [pingTimeout](./kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md) |  | <code>Duration</code> | Timeout after which PING HTTP request will be aborted and retried. |
 |  [requestHeadersWhitelist](./kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md) |  | <code>string[]</code> | List of Kibana client-side headers to send to Elasticsearch when request scoped cluster client is used. If this is an empty array then \*no\* client-side will be sent. |

diff --git a/...ment/core/server/kibana-plugin-core-server.legacyclusterclient._constructor_.md b/...ment/core/server/kibana-plugin-core-server.legacyclusterclient._constructor_.md
@@ -9,7 +9,7 @@ Constructs a new instance of the `LegacyClusterClient` class
 <b>Signature:</b>
 
 ```typescript
-constructor(config: LegacyElasticsearchClientConfig, log: Logger, getAuthHeaders?: GetAuthHeaders);
+constructor(config: LegacyElasticsearchClientConfig, log: Logger, type: string, getAuthHeaders?: GetAuthHeaders);
 ```
 
 ## Parameters
@@ -18,5 +18,6 @@ constructor(config: LegacyElasticsearchClientConfig, log: Logger, getAuthHeaders
 |  --- | --- | --- |
 |  config | <code>LegacyElasticsearchClientConfig</code> |  |
 |  log | <code>Logger</code> |  |
+|  type | <code>string</code> |  |
 |  getAuthHeaders | <code>GetAuthHeaders</code> |  |
 
diff --git a/docs/development/core/server/kibana-plugin-core-server.legacyclusterclient.md b/docs/development/core/server/kibana-plugin-core-server.legacyclusterclient.md
@@ -21,7 +21,7 @@ export declare class LegacyClusterClient implements ILegacyClusterClient
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(config, log, getAuthHeaders)](./kibana-plugin-core-server.legacyclusterclient._constructor_.md) |  | Constructs a new instance of the <code>LegacyClusterClient</code> class |
+|  [(constructor)(config, log, type, getAuthHeaders)](./kibana-plugin-core-server.legacyclusterclient._constructor_.md) |  | Constructs a new instance of the <code>LegacyClusterClient</code> class |
 
 ## Properties
 

diff --git a/...opment/core/server/kibana-plugin-core-server.legacyelasticsearchclientconfig.md b/...opment/core/server/kibana-plugin-core-server.legacyelasticsearchclientconfig.md
@@ -11,7 +11,7 @@
 <b>Signature:</b>
 
 ```typescript
-export declare type LegacyElasticsearchClientConfig = Pick<ConfigOptions, 'keepAlive' | 'log' | 'plugins'> & Pick<ElasticsearchConfig, 'apiVersion' | 'customHeaders' | 'logQueries' | 'requestHeadersWhitelist' | 'sniffOnStart' | 'sniffOnConnectionFault' | 'hosts' | 'username' | 'password'> & {
+export declare type LegacyElasticsearchClientConfig = Pick<ConfigOptions, 'keepAlive' | 'log' | 'plugins'> & Pick<ElasticsearchConfig, 'apiVersion' | 'customHeaders' | 'requestHeadersWhitelist' | 'sniffOnStart' | 'sniffOnConnectionFault' | 'hosts' | 'username' | 'password'> & {
     pingTimeout?: ElasticsearchConfig['pingTimeout'] | ConfigOptions['pingTimeout'];
     requestTimeout?: ElasticsearchConfig['requestTimeout'] | ConfigOptions['requestTimeout'];
     sniffInterval?: ElasticsearchConfig['sniffInterval'] | ConfigOptions['sniffInterval'];

diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc
@@ -59,7 +59,7 @@ To enable SSL/TLS for outbound connections to {es}, use the `https` protocol
 in this setting.
 
 | `elasticsearch.logQueries:`
- | Log queries sent to {es}. Requires <<logging-verbose, `logging.verbose`>> set to `true`.
+ | *deprecated* This setting is no longer used and will get removed in Kibana 8.0. Instead, set <<logging-verbose, `logging.verbose`>> to `true`
 This is useful for seeing the query DSL generated by applications that
 currently do not have an inspector, for example Timelion and Monitoring.
 *Default: `false`*

diff --git a/src/core/server/elasticsearch/client/client_config.test.ts b/src/core/server/elasticsearch/client/client_config.test.ts
@@ -15,7 +15,6 @@ const createConfig = (
 ): ElasticsearchClientConfig => {
   return {
     customHeaders: {},
-    logQueries: false,
     sniffOnStart: false,
     sniffOnConnectionFault: false,
     sniffInterval: false,

diff --git a/src/core/server/elasticsearch/client/client_config.ts b/src/core/server/elasticsearch/client/client_config.ts
@@ -22,7 +22,6 @@ import { DEFAULT_HEADERS } from '../default_headers';
 export type ElasticsearchClientConfig = Pick<
   ElasticsearchConfig,
   | 'customHeaders'
-  | 'logQueries'
   | 'sniffOnStart'
   | 'sniffOnConnectionFault'
   | 'requestHeadersWhitelist'

diff --git a/src/core/server/elasticsearch/client/cluster_client.test.ts b/src/core/server/elasticsearch/client/cluster_client.test.ts
@@ -19,7 +19,6 @@ const createConfig = (
   parts: Partial<ElasticsearchClientConfig> = {}
 ): ElasticsearchClientConfig => {
   return {
-    logQueries: false,
     sniffOnStart: false,
     sniffOnConnectionFault: false,
     sniffInterval: false,
@@ -57,24 +56,38 @@ describe('ClusterClient', () => {
   it('creates a single internal and scoped client during initialization', () => {
     const config = createConfig();
 
-    new ClusterClient(config, logger, getAuthHeaders);
+    new ClusterClient(config, logger, 'custom-type', getAuthHeaders);
 
     expect(configureClientMock).toHaveBeenCalledTimes(2);
-    expect(configureClientMock).toHaveBeenCalledWith(config, { logger });
-    expect(configureClientMock).toHaveBeenCalledWith(config, { logger, scoped: true });
+    expect(configureClientMock).toHaveBeenCalledWith(config, { logger, type: 'custom-type' });
+    expect(configureClientMock).toHaveBeenCalledWith(config, {
+      logger,
+      type: 'custom-type',
+      scoped: true,
+    });
   });
 
   describe('#asInternalUser', () => {
     it('returns the internal client', () => {
-      const clusterClient = new ClusterClient(createConfig(), logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(
+        createConfig(),
+        logger,
+        'custom-type',
+        getAuthHeaders
+      );
 
       expect(clusterClient.asInternalUser).toBe(internalClient);
     });
   });
 
   describe('#asScoped', () => {
     it('returns a scoped cluster client bound to the request', () => {
-      const clusterClient = new ClusterClient(createConfig(), logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(
+        createConfig(),
+        logger,
+        'custom-type',
+        getAuthHeaders
+      );
       const request = httpServerMock.createKibanaRequest();
 
       const scopedClusterClient = clusterClient.asScoped(request);
@@ -87,7 +100,12 @@ describe('ClusterClient', () => {
     });
 
     it('returns a distinct scoped cluster client on each call', () => {
-      const clusterClient = new ClusterClient(createConfig(), logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(
+        createConfig(),
+        logger,
+        'custom-type',
+        getAuthHeaders
+      );
       const request = httpServerMock.createKibanaRequest();
 
       const scopedClusterClient1 = clusterClient.asScoped(request);
@@ -105,7 +123,7 @@ describe('ClusterClient', () => {
       });
       getAuthHeaders.mockReturnValue({});
 
-      const clusterClient = new ClusterClient(config, logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(config, logger, 'custom-type', getAuthHeaders);
       const request = httpServerMock.createKibanaRequest({
         headers: {
           foo: 'bar',
@@ -130,7 +148,7 @@ describe('ClusterClient', () => {
         other: 'nope',
       });
 
-      const clusterClient = new ClusterClient(config, logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(config, logger, 'custom-type', getAuthHeaders);
       const request = httpServerMock.createKibanaRequest({});
 
       clusterClient.asScoped(request);
@@ -150,7 +168,7 @@ describe('ClusterClient', () => {
         other: 'nope',
       });
 
-      const clusterClient = new ClusterClient(config, logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(config, logger, 'custom-type', getAuthHeaders);
       const request = httpServerMock.createKibanaRequest({
         headers: {
           authorization: 'override',
@@ -175,7 +193,7 @@ describe('ClusterClient', () => {
       });
       getAuthHeaders.mockReturnValue({});
 
-      const clusterClient = new ClusterClient(config, logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(config, logger, 'custom-type', getAuthHeaders);
       const request = httpServerMock.createKibanaRequest({});
 
       clusterClient.asScoped(request);
@@ -195,7 +213,7 @@ describe('ClusterClient', () => {
       const config = createConfig();
       getAuthHeaders.mockReturnValue({});
 
-      const clusterClient = new ClusterClient(config, logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(config, logger, 'custom-type', getAuthHeaders);
       const request = httpServerMock.createKibanaRequest({
         kibanaRequestState: { requestId: 'my-fake-id', requestUuid: 'ignore-this-id' },
       });
@@ -223,7 +241,7 @@ describe('ClusterClient', () => {
         foo: 'auth',
       });
 
-      const clusterClient = new ClusterClient(config, logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(config, logger, 'custom-type', getAuthHeaders);
       const request = httpServerMock.createKibanaRequest({});
 
       clusterClient.asScoped(request);
@@ -249,7 +267,7 @@ describe('ClusterClient', () => {
       });
       getAuthHeaders.mockReturnValue({});
 
-      const clusterClient = new ClusterClient(config, logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(config, logger, 'custom-type', getAuthHeaders);
       const request = httpServerMock.createKibanaRequest({
         headers: { foo: 'request' },
       });
@@ -276,7 +294,7 @@ describe('ClusterClient', () => {
       });
       getAuthHeaders.mockReturnValue({});
 
-      const clusterClient = new ClusterClient(config, logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(config, logger, 'custom-type', getAuthHeaders);
       const request = httpServerMock.createKibanaRequest();
 
       clusterClient.asScoped(request);
@@ -297,7 +315,7 @@ describe('ClusterClient', () => {
       });
       getAuthHeaders.mockReturnValue({});
 
-      const clusterClient = new ClusterClient(config, logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(config, logger, 'custom-type', getAuthHeaders);
       const request = httpServerMock.createKibanaRequest({
         headers: { [headerKey]: 'foo' },
       });
@@ -321,7 +339,7 @@ describe('ClusterClient', () => {
       });
       getAuthHeaders.mockReturnValue({});
 
-      const clusterClient = new ClusterClient(config, logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(config, logger, 'custom-type', getAuthHeaders);
       const request = httpServerMock.createKibanaRequest({
         headers: { foo: 'request' },
         kibanaRequestState: { requestId: 'from request', requestUuid: 'ignore-this-id' },
@@ -344,7 +362,7 @@ describe('ClusterClient', () => {
       });
       getAuthHeaders.mockReturnValue({});
 
-      const clusterClient = new ClusterClient(config, logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(config, logger, 'custom-type', getAuthHeaders);
       const request = {
         headers: {
           authorization: 'auth',
@@ -368,7 +386,7 @@ describe('ClusterClient', () => {
         authorization: 'auth',
       });
 
-      const clusterClient = new ClusterClient(config, logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(config, logger, 'custom-type', getAuthHeaders);
       const request = {
         headers: {
           foo: 'bar',
@@ -387,7 +405,12 @@ describe('ClusterClient', () => {
 
   describe('#close', () => {
     it('closes both underlying clients', async () => {
-      const clusterClient = new ClusterClient(createConfig(), logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(
+        createConfig(),
+        logger,
+        'custom-type',
+        getAuthHeaders
+      );
 
       await clusterClient.close();
 
@@ -398,7 +421,12 @@ describe('ClusterClient', () => {
     it('waits for both clients to close', async (done) => {
       expect.assertions(4);
 
-      const clusterClient = new ClusterClient(createConfig(), logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(
+        createConfig(),
+        logger,
+        'custom-type',
+        getAuthHeaders
+      );
 
       let internalClientClosed = false;
       let scopedClientClosed = false;
@@ -436,7 +464,12 @@ describe('ClusterClient', () => {
     });
 
     it('return a rejected promise is any client rejects', async () => {
-      const clusterClient = new ClusterClient(createConfig(), logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(
+        createConfig(),
+        logger,
+        'custom-type',
+        getAuthHeaders
+      );
 
       internalClient.close.mockRejectedValue(new Error('error closing client'));
 
@@ -446,7 +479,12 @@ describe('ClusterClient', () => {
     });
 
     it('does nothing after the first call', async () => {
-      const clusterClient = new ClusterClient(createConfig(), logger, getAuthHeaders);
+      const clusterClient = new ClusterClient(
+        createConfig(),
+        logger,
+        'custom-type',
+        getAuthHeaders
+      );
 
       await clusterClient.close();
 

diff --git a/src/core/server/elasticsearch/client/cluster_client.ts b/src/core/server/elasticsearch/client/cluster_client.ts
@@ -60,10 +60,11 @@ export class ClusterClient implements ICustomClusterClient {
   constructor(
     private readonly config: ElasticsearchClientConfig,
     logger: Logger,
+    type: string,
     private readonly getAuthHeaders: GetAuthHeaders = noop
   ) {
-    this.asInternalUser = configureClient(config, { logger });
-    this.rootScopedClient = configureClient(config, { logger, scoped: true });
+    this.asInternalUser = configureClient(config, { logger, type });
+    this.rootScopedClient = configureClient(config, { logger, type, scoped: true });
   }
 
   asScoped(request: ScopeableRequest) {