Skip to content

Commit a77f8ff

Browse files
gsoldevilagsoldevila
authored
Create HTTP Agent manager (#137748)
* Create HTTP Agent factory * Properly extract agent options * Use independent Agent for preboot * Create AgentManager to obtain factories * Make client type mandatory, fix outdated mocks * Temporarily force new Agent creation * Revert changes in utils * Add correct defaults for Agent Options, support proxy agent. * Forgot to push package.json * Add hpagent dependency in BUILD.bazel * Get rid of hpagent (proxy param is not exposed in kibana.yml) * Remove hpagent from BUILD.bazel * Use different agents for normal Vs scoped client * Fix Agent constructor params * Fix incorrect access to err.message * Use separate Agent for scoped client * Create different agents for std vs scoped * Provide different Agent instances if config differs * Create a new Agent for each ES Client * Restructure agent store. Add UTs * Remove obsolete comment * Simplify AgentManager store structure (no type needed) * Fine tune client_config return type * Misc enhancements following PR comments * Fix missing param in cli_setup/utils
1 parent 0384ff8 commit a77f8ff

File tree

14 files changed

+418
-39
lines changed

14 files changed

+418
-39
lines changed

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

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
export { ScopedClusterClient } from './src/scoped_cluster_client';
1010
export { ClusterClient } from './src/cluster_client';
1111
export { configureClient } from './src/configure_client';
12+
export { AgentManager } from './src/agent_manager';
1213
export { getRequestDebugMeta, getErrorMessage } from './src/log_query_and_deprecation';
1314
export {
1415
PRODUCT_RESPONSE_HEADER,

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

+125
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
/*
2+
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
3+
* or more contributor license agreements. Licensed under the Elastic License
4+
* 2.0 and the Server Side Public License, v 1; you may not use this file except
5+
* in compliance with, at your election, the Elastic License 2.0 or the Server
6+
* Side Public License, v 1.
7+
*/
8+
9+
import { AgentManager } from './agent_manager';
10+
import { Agent as HttpAgent } from 'http';
11+
import { Agent as HttpsAgent } from 'https';
12+
13+
jest.mock('http');
14+
jest.mock('https');
15+
16+
const HttpAgentMock = HttpAgent as jest.Mock<HttpAgent>;
17+
const HttpsAgentMock = HttpsAgent as jest.Mock<HttpsAgent>;
18+
19+
describe('AgentManager', () => {
20+
afterEach(() => {
21+
HttpAgentMock.mockClear();
22+
HttpsAgentMock.mockClear();
23+
});
24+
25+
describe('#getAgentFactory()', () => {
26+
it('provides factories which are different at each call', () => {
27+
const agentManager = new AgentManager();
28+
const agentFactory1 = agentManager.getAgentFactory();
29+
const agentFactory2 = agentManager.getAgentFactory();
30+
expect(agentFactory1).not.toEqual(agentFactory2);
31+
});
32+
33+
describe('one agent factory', () => {
34+
it('provides instances of the http and https Agent classes', () => {
35+
const mockedHttpAgent = new HttpAgent();
36+
HttpAgentMock.mockImplementationOnce(() => mockedHttpAgent);
37+
const mockedHttpsAgent = new HttpsAgent();
38+
HttpsAgentMock.mockImplementationOnce(() => mockedHttpsAgent);
39+
const agentManager = new AgentManager();
40+
const agentFactory = agentManager.getAgentFactory();
41+
const httpAgent = agentFactory({ url: new URL('http://elastic-node-1:9200') });
42+
const httpsAgent = agentFactory({ url: new URL('https://elastic-node-1:9200') });
43+
expect(httpAgent).toEqual(mockedHttpAgent);
44+
expect(httpsAgent).toEqual(mockedHttpsAgent);
45+
});
46+
47+
it('provides Agents with a valid default configuration', () => {
48+
const agentManager = new AgentManager();
49+
const agentFactory = agentManager.getAgentFactory();
50+
agentFactory({ url: new URL('http://elastic-node-1:9200') });
51+
expect(HttpAgent).toBeCalledTimes(1);
52+
expect(HttpAgent).toBeCalledWith({
53+
keepAlive: true,
54+
keepAliveMsecs: 50000,
55+
maxFreeSockets: 256,
56+
maxSockets: 256,
57+
scheduling: 'lifo',
58+
});
59+
});
60+
61+
it('takes into account the provided configurations', () => {
62+
const agentManager = new AgentManager({ maxFreeSockets: 32, maxSockets: 2048 });
63+
const agentFactory = agentManager.getAgentFactory({
64+
maxSockets: 1024,
65+
scheduling: 'fifo',
66+
});
67+
agentFactory({ url: new URL('http://elastic-node-1:9200') });
68+
expect(HttpAgent).toBeCalledTimes(1);
69+
expect(HttpAgent).toBeCalledWith({
70+
keepAlive: true,
71+
keepAliveMsecs: 50000,
72+
maxFreeSockets: 32,
73+
maxSockets: 1024,
74+
scheduling: 'fifo',
75+
});
76+
});
77+
78+
it('provides Agents that match the URLs protocol', () => {
79+
const agentManager = new AgentManager();
80+
const agentFactory = agentManager.getAgentFactory();
81+
agentFactory({ url: new URL('http://elastic-node-1:9200') });
82+
expect(HttpAgent).toHaveBeenCalledTimes(1);
83+
expect(HttpsAgent).toHaveBeenCalledTimes(0);
84+
agentFactory({ url: new URL('https://elastic-node-3:9200') });
85+
expect(HttpAgent).toHaveBeenCalledTimes(1);
86+
expect(HttpsAgent).toHaveBeenCalledTimes(1);
87+
});
88+
89+
it('provides the same Agent iif URLs use the same protocol', () => {
90+
const agentManager = new AgentManager();
91+
const agentFactory = agentManager.getAgentFactory();
92+
const agent1 = agentFactory({ url: new URL('http://elastic-node-1:9200') });
93+
const agent2 = agentFactory({ url: new URL('http://elastic-node-2:9200') });
94+
const agent3 = agentFactory({ url: new URL('https://elastic-node-3:9200') });
95+
const agent4 = agentFactory({ url: new URL('https://elastic-node-4:9200') });
96+
97+
expect(agent1).toEqual(agent2);
98+
expect(agent1).not.toEqual(agent3);
99+
expect(agent3).toEqual(agent4);
100+
});
101+
102+
it('dereferences an agent instance when the agent is closed', () => {
103+
const agentManager = new AgentManager();
104+
const agentFactory = agentManager.getAgentFactory();
105+
const agent = agentFactory({ url: new URL('http://elastic-node-1:9200') });
106+
// eslint-disable-next-line dot-notation
107+
expect(agentManager['httpStore'].has(agent)).toEqual(true);
108+
agent.destroy();
109+
// eslint-disable-next-line dot-notation
110+
expect(agentManager['httpStore'].has(agent)).toEqual(false);
111+
});
112+
});
113+
114+
describe('two agent factories', () => {
115+
it('never provide the same Agent instance even if they use the same type', () => {
116+
const agentManager = new AgentManager();
117+
const agentFactory1 = agentManager.getAgentFactory();
118+
const agentFactory2 = agentManager.getAgentFactory();
119+
const agent1 = agentFactory1({ url: new URL('http://elastic-node-1:9200') });
120+
const agent2 = agentFactory2({ url: new URL('http://elastic-node-1:9200') });
121+
expect(agent1).not.toEqual(agent2);
122+
});
123+
});
124+
});
125+
});

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

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
/*
2+
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
3+
* or more contributor license agreements. Licensed under the Elastic License
4+
* 2.0 and the Server Side Public License, v 1; you may not use this file except
5+
* in compliance with, at your election, the Elastic License 2.0 or the Server
6+
* Side Public License, v 1.
7+
*/
8+
9+
import { Agent as HttpAgent } from 'http';
10+
import { Agent as HttpsAgent } from 'https';
11+
import { ConnectionOptions, HttpAgentOptions } from '@elastic/elasticsearch';
12+
13+
const HTTPS = 'https:';
14+
const DEFAULT_CONFIG: HttpAgentOptions = {
15+
keepAlive: true,
16+
keepAliveMsecs: 50000,
17+
maxSockets: 256,
18+
maxFreeSockets: 256,
19+
scheduling: 'lifo',
20+
};
21+
22+
export type NetworkAgent = HttpAgent | HttpsAgent;
23+
export type AgentFactory = (connectionOpts: ConnectionOptions) => NetworkAgent;
24+
25+
/**
26+
* Allows obtaining Agent factories, which can then be fed into elasticsearch-js's Client class.
27+
* Ideally, we should obtain one Agent factory for each ES Client class.
28+
* This allows using the same Agent across all the Pools and Connections of the Client (one per ES node).
29+
*
30+
* Agent instances are stored internally to allow collecting metrics (nbr of active/idle connections to ES).
31+
*
32+
* Using the same Agent factory across multiple ES Client instances is strongly discouraged, cause ES Client
33+
* exposes methods that can modify the underlying pools, effectively impacting the connections of other Clients.
34+
* @internal
35+
**/
36+
export class AgentManager {
37+
// Stores Https Agent instances
38+
private httpsStore: Set<HttpsAgent>;
39+
// Stores Http Agent instances
40+
private httpStore: Set<HttpAgent>;
41+
42+
constructor(private agentOptions: HttpAgentOptions = DEFAULT_CONFIG) {
43+
this.httpsStore = new Set();
44+
this.httpStore = new Set();
45+
}
46+
47+
public getAgentFactory(agentOptions?: HttpAgentOptions): AgentFactory {
48+
// a given agent factory always provides the same Agent instances (for the same protocol)
49+
// we keep references to the instances at factory level, to be able to reuse them
50+
let httpAgent: HttpAgent;
51+
let httpsAgent: HttpsAgent;
52+
53+
return (connectionOpts: ConnectionOptions): NetworkAgent => {
54+
if (connectionOpts.url.protocol === HTTPS) {
55+
if (!httpsAgent) {
56+
const config = Object.assign(
57+
{},
58+
DEFAULT_CONFIG,
59+
this.agentOptions,
60+
agentOptions,
61+
connectionOpts.tls
62+
);
63+
httpsAgent = new HttpsAgent(config);
64+
this.httpsStore.add(httpsAgent);
65+
dereferenceOnDestroy(this.httpsStore, httpsAgent);
66+
}
67+
68+
return httpsAgent;
69+
}
70+
71+
if (!httpAgent) {
72+
const config = Object.assign({}, DEFAULT_CONFIG, this.agentOptions, agentOptions);
73+
httpAgent = new HttpAgent(config);
74+
this.httpStore.add(httpAgent);
75+
dereferenceOnDestroy(this.httpStore, httpAgent);
76+
}
77+
78+
return httpAgent;
79+
};
80+
}
81+
}
82+
83+
const dereferenceOnDestroy = (protocolStore: Set<NetworkAgent>, agent: NetworkAgent) => {
84+
const doDestroy = agent.destroy.bind(agent);
85+
agent.destroy = () => {
86+
protocolStore.delete(agent);
87+
doDestroy();
88+
};
89+
};

‎packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/client_config.ts

+5-3
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@
99
import { ConnectionOptions as TlsConnectionOptions } from 'tls';
1010
import { URL } from 'url';
1111
import { Duration } from 'moment';
12-
import type { ClientOptions } from '@elastic/elasticsearch/lib/client';
12+
import type { ClientOptions, HttpAgentOptions } from '@elastic/elasticsearch';
1313
import type { ElasticsearchClientConfig } from '@kbn/core-elasticsearch-server';
1414
import { DEFAULT_HEADERS } from './headers';
1515

16+
export type ParsedClientOptions = Omit<ClientOptions, 'agent'> & { agent: HttpAgentOptions };
17+
1618
/**
1719
* Parse the client options from given client config and `scoped` flag.
1820
*
@@ -23,8 +25,8 @@ import { DEFAULT_HEADERS } from './headers';
2325
export function parseClientOptions(
2426
config: ElasticsearchClientConfig,
2527
scoped: boolean
26-
): ClientOptions {
27-
const clientOptions: ClientOptions = {
28+
): ParsedClientOptions {
29+
const clientOptions: ParsedClientOptions = {
2830
sniffOnStart: config.sniffOnStart,
2931
sniffOnConnectionFault: config.sniffOnConnectionFault,
3032
headers: {

0 commit comments

Comments
 (0)