Collect metrics about the active/idle connections to ES nodes

packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts

@@ -61,6 +61,19 @@ const mockedResponse: StatusResponse = {
         '15m': 0.1,
       },
     },
+    elasticsearch_client: {
+      protocol: 'https',
+      connectedNodes: 3,
+      nodesWithActiveSockets: 3,
+      nodesWithIdleSockets: 1,
+      totalActiveSockets: 25,
+      totalIdleSockets: 2,
+      totalQueuedRequests: 0,
+      mostActiveNodeSockets: 15,
+      averageActiveSocketsPerNode: 8,
+      mostIdleNodeSockets: 2,
+      averageIdleSocketsPerNode: 0.5,
+    },
     process: {
       pid: 1,
       memory: {

packages/core/elasticsearch/core-elasticsearch-client-server-internal/index.ts

@@ -9,7 +9,7 @@
 export { ScopedClusterClient } from './src/scoped_cluster_client';
 export { ClusterClient } from './src/cluster_client';
 export { configureClient } from './src/configure_client';
-export { AgentManager } from './src/agent_manager';
+export { type AgentStore, AgentManager } from './src/agent_manager';
 export { getRequestDebugMeta, getErrorMessage } from './src/log_query_and_deprecation';
 export {
   PRODUCT_RESPONSE_HEADER,

packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/agent_manager.test.ts

@@ -104,10 +104,10 @@ describe('AgentManager', () => {
         const agentFactory = agentManager.getAgentFactory();
         const agent = agentFactory({ url: new URL('http://elastic-node-1:9200') });
         // eslint-disable-next-line dot-notation
-        expect(agentManager['httpStore'].has(agent)).toEqual(true);
+        expect(agentManager['agents'].has(agent)).toEqual(true);
         agent.destroy();
         // eslint-disable-next-line dot-notation
-        expect(agentManager['httpStore'].has(agent)).toEqual(false);
+        expect(agentManager['agents'].has(agent)).toEqual(false);
       });
     });
 
@@ -122,4 +122,21 @@ describe('AgentManager', () => {
       });
     });
   });
+
+  describe('#getAgents()', () => {
+    it('returns the created HTTP and HTTPs Agent instances', () => {
+      const agentManager = new AgentManager();
+      const agentFactory1 = agentManager.getAgentFactory();
+      const agentFactory2 = agentManager.getAgentFactory();
+      const agent1 = agentFactory1({ url: new URL('http://elastic-node-1:9200') });
+      const agent2 = agentFactory2({ url: new URL('http://elastic-node-1:9200') });
+      const agent3 = agentFactory1({ url: new URL('https://elastic-node-1:9200') });
+      const agent4 = agentFactory2({ url: new URL('https://elastic-node-1:9200') });
+
+      const agents = agentManager.getAgents();
+
+      expect(agents.size).toEqual(4);
+      expect([...agents]).toEqual(expect.arrayContaining([agent1, agent2, agent3, agent4]));
+    });
+  });
 });

packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/agent_manager.ts

@@ -8,7 +8,7 @@
 
 import { Agent as HttpAgent } from 'http';
 import { Agent as HttpsAgent } from 'https';
-import { ConnectionOptions, HttpAgentOptions } from '@elastic/elasticsearch';
+import type { ConnectionOptions, HttpAgentOptions } from '@elastic/elasticsearch';
 
 const HTTPS = 'https:';
 const DEFAULT_CONFIG: HttpAgentOptions = {
@@ -22,6 +22,14 @@ const DEFAULT_CONFIG: HttpAgentOptions = {
 export type NetworkAgent = HttpAgent | HttpsAgent;
 export type AgentFactory = (connectionOpts: ConnectionOptions) => NetworkAgent;
 
+export interface AgentFactoryProvider {
+  getAgentFactory(agentOptions?: HttpAgentOptions): AgentFactory;
+}
+
+export interface AgentStore {
+  getAgents(): Set<NetworkAgent>;
+}
+
 /**
  * Allows obtaining Agent factories, which can then be fed into elasticsearch-js's Client class.
  * Ideally, we should obtain one Agent factory for each ES Client class.
@@ -33,15 +41,11 @@ export type AgentFactory = (connectionOpts: ConnectionOptions) => NetworkAgent;
  * exposes methods that can modify the underlying pools, effectively impacting the connections of other Clients.
  * @internal
  **/
-export class AgentManager {
-  // Stores Https Agent instances
-  private httpsStore: Set<HttpsAgent>;
-  // Stores Http Agent instances
-  private httpStore: Set<HttpAgent>;
+export class AgentManager implements AgentFactoryProvider, AgentStore {
+  private agents: Set<HttpAgent>;
 
   constructor(private agentOptions: HttpAgentOptions = DEFAULT_CONFIG) {
-    this.httpsStore = new Set();
-    this.httpStore = new Set();
+    this.agents = new Set();
   }
 
   public getAgentFactory(agentOptions?: HttpAgentOptions): AgentFactory {
@@ -61,8 +65,8 @@ export class AgentManager {
             connectionOpts.tls
           );
           httpsAgent = new HttpsAgent(config);
-          this.httpsStore.add(httpsAgent);
-          dereferenceOnDestroy(this.httpsStore, httpsAgent);
+          this.agents.add(httpsAgent);
+          dereferenceOnDestroy(this.agents, httpsAgent);
         }
 
         return httpsAgent;
@@ -71,19 +75,23 @@ export class AgentManager {
       if (!httpAgent) {
         const config = Object.assign({}, DEFAULT_CONFIG, this.agentOptions, agentOptions);
         httpAgent = new HttpAgent(config);
-        this.httpStore.add(httpAgent);
-        dereferenceOnDestroy(this.httpStore, httpAgent);
+        this.agents.add(httpAgent);
+        dereferenceOnDestroy(this.agents, httpAgent);
       }
 
       return httpAgent;
     };
   }
+
+  public getAgents(): Set<NetworkAgent> {
+    return this.agents;
+  }
 }
 
-const dereferenceOnDestroy = (protocolStore: Set<NetworkAgent>, agent: NetworkAgent) => {
+const dereferenceOnDestroy = (store: Set<NetworkAgent>, agent: NetworkAgent) => {
   const doDestroy = agent.destroy.bind(agent);
   agent.destroy = () => {
-    protocolStore.delete(agent);
+    store.delete(agent);
     doDestroy();
   };
 };

packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/cluster_client.test.ts

@@ -46,15 +46,15 @@ describe('ClusterClient', () => {
   let authHeaders: ReturnType<typeof httpServiceMock.createAuthHeaderStorage>;
   let internalClient: jest.Mocked<Client>;
   let scopedClient: jest.Mocked<Client>;
-  let agentManager: AgentManager;
+  let agentFactoryProvider: AgentManager;
 
   const mockTransport = { mockTransport: true };
 
   beforeEach(() => {
     logger = loggingSystemMock.createLogger();
     internalClient = createClient();
     scopedClient = createClient();
-    agentManager = new AgentManager();
+    agentFactoryProvider = new AgentManager();
 
     authHeaders = httpServiceMock.createAuthHeaderStorage();
     authHeaders.get.mockImplementation(() => ({
@@ -84,21 +84,21 @@ describe('ClusterClient', () => {
       authHeaders,
       type: 'custom-type',
       getExecutionContext: getExecutionContextMock,
-      agentManager,
+      agentFactoryProvider,
       kibanaVersion,
     });
 
     expect(configureClientMock).toHaveBeenCalledTimes(2);
     expect(configureClientMock).toHaveBeenCalledWith(config, {
       logger,
-      agentManager,
+      agentFactoryProvider,
       kibanaVersion,
       type: 'custom-type',
       getExecutionContext: getExecutionContextMock,
     });
     expect(configureClientMock).toHaveBeenCalledWith(config, {
       logger,
-      agentManager,
+      agentFactoryProvider,
       kibanaVersion,
       type: 'custom-type',
       getExecutionContext: getExecutionContextMock,
@@ -113,7 +113,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
 
@@ -128,7 +128,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = httpServerMock.createKibanaRequest();
@@ -155,7 +155,7 @@ describe('ClusterClient', () => {
         authHeaders,
         getExecutionContext,
         getUnauthorizedErrorHandler,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = httpServerMock.createKibanaRequest();
@@ -179,7 +179,7 @@ describe('ClusterClient', () => {
         authHeaders,
         getExecutionContext,
         getUnauthorizedErrorHandler,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = httpServerMock.createKibanaRequest();
@@ -212,7 +212,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = httpServerMock.createKibanaRequest();
@@ -237,7 +237,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = httpServerMock.createKibanaRequest({
@@ -271,7 +271,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = httpServerMock.createKibanaRequest({});
@@ -305,7 +305,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = httpServerMock.createKibanaRequest({
@@ -344,7 +344,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = httpServerMock.createKibanaRequest({});
@@ -373,7 +373,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = httpServerMock.createKibanaRequest({
@@ -410,7 +410,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = httpServerMock.createKibanaRequest({});
@@ -445,7 +445,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = httpServerMock.createKibanaRequest({
@@ -482,7 +482,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = httpServerMock.createKibanaRequest();
@@ -513,7 +513,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = httpServerMock.createKibanaRequest({
@@ -547,7 +547,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = httpServerMock.createKibanaRequest({
@@ -579,7 +579,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = {
@@ -612,7 +612,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
       const request = {
@@ -640,7 +640,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
 
@@ -658,7 +658,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
 
@@ -703,7 +703,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });
 
@@ -720,7 +720,7 @@ describe('ClusterClient', () => {
         logger,
         type: 'custom-type',
         authHeaders,
-        agentManager,
+        agentFactoryProvider,
         kibanaVersion,
       });