Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new elasticsearch client #69905

Merged
merged 55 commits into from
Jul 8, 2020
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
10f0846
add "@elastic/elasticsearch" to dependencies
pgayvallet Jun 25, 2020
e923ce5
first POC of new client
pgayvallet Jun 25, 2020
175e0cb
add logging
pgayvallet Jun 25, 2020
f56a506
Merge remote-tracking branch 'upstream/master' into kbn-35508-add-new…
pgayvallet Jun 29, 2020
24ac36b
add generation script for client facade API and implementation
pgayvallet Jun 29, 2020
024f3df
add back keepAlive
pgayvallet Jun 30, 2020
cfa547a
Merge remote-tracking branch 'upstream/master' into kbn-35508-add-new…
pgayvallet Jun 30, 2020
eecd780
add exports from client
pgayvallet Jun 30, 2020
8c6c9fc
add new client mocks
pgayvallet Jun 30, 2020
c7a2cf1
add some doc
pgayvallet Jun 30, 2020
193fecc
fix API usages
pgayvallet Jun 30, 2020
b8935d7
rename legacy client to legacy in service
pgayvallet Jun 30, 2020
f268e63
rename currently unused config/client observable
pgayvallet Jun 30, 2020
73f68b8
wire new client to service & update mocks
pgayvallet Jun 30, 2020
2c5a489
fix mock type
pgayvallet Jun 30, 2020
c7ae6aa
export client types
pgayvallet Jun 30, 2020
93d05ee
add transport.request
pgayvallet Jun 30, 2020
4156411
more doc
pgayvallet Jun 30, 2020
5a3fd9c
migrate version_check to new client
pgayvallet Jun 30, 2020
71a27bb
fix default port logic
pgayvallet Jun 30, 2020
e48f3ad
rename legacy client mocks
pgayvallet Jun 30, 2020
bdacda3
move legacy client mocks to legacy folder
pgayvallet Jun 30, 2020
152b6dc
start adding tests
pgayvallet Jun 30, 2020
b265759
add configure_client tests
pgayvallet Jul 1, 2020
9e356e8
add get_client_facade tests
pgayvallet Jul 1, 2020
353253f
Merge remote-tracking branch 'upstream/master' into kbn-35508-add-new…
pgayvallet Jul 1, 2020
7e49f65
bump client to 7.8
pgayvallet Jul 1, 2020
bda204e
add cluster_client tests
pgayvallet Jul 1, 2020
28b8cfc
expose new client on internal contract only
pgayvallet Jul 1, 2020
8cd1ed2
revert using the new client for es version check
pgayvallet Jul 1, 2020
205c100
add service level test for new client
pgayvallet Jul 1, 2020
7819166
update generated API
pgayvallet Jul 1, 2020
d1cdb0a
Merge remote-tracking branch 'upstream/master' into kbn-35508-add-new…
pgayvallet Jul 1, 2020
80bfc97
Merge remote-tracking branch 'upstream/master' into kbn-35508-add-new…
pgayvallet Jul 1, 2020
bf18e61
Revert "rename legacy client mocks"
pgayvallet Jul 1, 2020
6c4ff93
Merge remote-tracking branch 'upstream/master' into kbn-35508-add-new…
pgayvallet Jul 1, 2020
8a397d0
address some review comments
pgayvallet Jul 1, 2020
533212b
Merge remote-tracking branch 'upstream/master' into kbn-35508-add-new…
pgayvallet Jul 2, 2020
0a09aee
revert ts-expect-error from unowned files
pgayvallet Jul 2, 2020
1a68ea1
move response mocks to mocks.ts
pgayvallet Jul 3, 2020
f956fb4
Remove generated facade, use ES Client directly
pgayvallet Jul 3, 2020
56db6c4
log queries even in case of error
pgayvallet Jul 3, 2020
d6f1c9d
nits
pgayvallet Jul 3, 2020
83b7246
use direct properties instead of accessors
pgayvallet Jul 3, 2020
a764b10
handle async closing of client
pgayvallet Jul 3, 2020
9d272ba
Merge remote-tracking branch 'upstream/master' into kbn-35508-add-new…
pgayvallet Jul 3, 2020
3f1d9bd
Merge remote-tracking branch 'upstream/master' into kbn-35508-add-new…
pgayvallet Jul 6, 2020
88ae350
Merge remote-tracking branch 'upstream/master' into kbn-35508-add-new…
pgayvallet Jul 6, 2020
cb242e7
Merge remote-tracking branch 'upstream/master' into kbn-35508-add-new…
pgayvallet Jul 7, 2020
413a97d
review nits
pgayvallet Jul 7, 2020
c0d7f3a
ElasticSearchClient -> ElasticsearchClient
pgayvallet Jul 7, 2020
022e4a2
add test for encoded querystring
pgayvallet Jul 7, 2020
0dc69b4
Merge remote-tracking branch 'upstream/master' into kbn-35508-add-new…
pgayvallet Jul 8, 2020
5acfe96
adapt test file
pgayvallet Jul 8, 2020
f059964
Merge remote-tracking branch 'upstream/master' into kbn-35508-add-new…
pgayvallet Jul 8, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@
"@elastic/apm-rum": "^5.2.0",
"@elastic/charts": "19.5.2",
"@elastic/datemath": "5.0.3",
"@elastic/elasticsearch": "^7.7.1",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The client follows the stack versioning, meaning that using the client 7.x in kibana master will cause issues. You should use the client master branch.
Currently, we are not publishing any 8.x version on npm, but we could do it if it does help you.
Here you can find the compatibility table of the client.
If you want to install the master branch of the client:

npm install elastic/elasticsearch-js#master

Copy link
Contributor

@mshustov mshustov Jun 30, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the client released separately for every Stack release? Should it be another place to sync across the Stack when bumping a Kibana version?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we do a release for every major.minor of the stack, patches are released as soon as it's needed.

Copy link
Contributor Author

@pgayvallet pgayvallet Jun 30, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hum, this may be quite problematic AFAIK, as kibana master is targeting 8.0, but the current branch (7.9 atm for example) is targeting 7.X

That means that we would need to have different versions (with potential differences in APIs) between our kibana master branch and our next-release branch?

This feels like it could become a backport nightmare, doesn't it?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@delvedor Can you elaborate on the typical changes between versions? If newer versions only change to support or remove new or deprecated ES functionality then this shouldn't cause any problems for us that aren't already caused by ES.

But if elasticsearch-js plans to make breaking changes to it's API signatures this adds an additional maintenance burden and we will have to migrate all code within the release timeframe.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The client follows semantic versioning, so there will never be a breaking change between minor or patch releases, but there might be between majors.
Minor releases are always additive, in a generic minor release you will find new ES endpoints and some additional features of the client, for example, in the last 2/3 minors, client helpers have been added.

If the client needs to do a breaking change, which can be dropping the support for a specific version of Node, remove/change a configuration option, or drop an API, that will happen in a major release.

The only parts of the client that could have a breaking change between minors are the helpers and the type definitions, which are still experimental (even if they are stable and not expected to change unless there is a very good reason).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The client does prereleases as soon as there is a feature freeze, if you take a look at the published versions on npm you will see few rcs.

"@elastic/ems-client": "7.9.3",
"@elastic/eui": "24.1.0",
"@elastic/filesaver": "1.1.2",
Expand Down Expand Up @@ -294,7 +295,6 @@
"devDependencies": {
"@babel/parser": "^7.10.2",
"@babel/types": "^7.10.2",
"@elastic/elasticsearch": "^7.4.0",
"@elastic/eslint-config-kibana": "0.15.0",
"@elastic/eslint-plugin-eui": "0.0.2",
"@elastic/github-checks-reporter": "0.0.20b3",
Expand Down
21 changes: 21 additions & 0 deletions scripts/generate_es_client.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

require('../src/setup_node_env');
require('../src/dev/generate_es_client');
145 changes: 145 additions & 0 deletions src/core/server/elasticsearch/client/client_config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import { ConnectionOptions as TlsConnectionOptions } from 'tls';
import { URL } from 'url';
import { Duration } from 'moment';
import { ClientOptions, NodeOptions } from '@elastic/elasticsearch';
import { ElasticsearchConfig } from '../elasticsearch_config';

/**
* @privateRemarks Config that consumers can pass to the Elasticsearch JS client is complex and includes
* not only entries from standard `elasticsearch.*` yaml config, but also some Elasticsearch JS
* client specific options like `keepAlive` or `plugins` (that eventually will be deprecated).
*
* @public
*/
export type ElasticsearchClientConfig = Pick<
ElasticsearchConfig,
| 'customHeaders'
| 'logQueries'
| 'sniffOnStart'
| 'sniffOnConnectionFault'
| 'requestHeadersWhitelist'
| 'sniffInterval'
| 'hosts'
| 'username'
| 'password'
> & {
pingTimeout?: ElasticsearchConfig['pingTimeout'] | ClientOptions['pingTimeout'];
requestTimeout?: ElasticsearchConfig['requestTimeout'] | ClientOptions['requestTimeout'];
ssl?: Partial<ElasticsearchConfig['ssl']>;
};

export function parseClientOptions(
config: ElasticsearchClientConfig,
scoped: boolean
): ClientOptions {
const clientOptions: ClientOptions = {
sniffOnStart: config.sniffOnStart,
sniffOnConnectionFault: config.sniffOnConnectionFault,
headers: config.customHeaders,
pgayvallet marked this conversation as resolved.
Show resolved Hide resolved
};

if (config.pingTimeout != null) {
clientOptions.pingTimeout = getDurationAsMs(config.pingTimeout);
}
if (config.requestTimeout != null) {
clientOptions.requestTimeout = getDurationAsMs(config.requestTimeout);
}
if (config.sniffInterval) {
clientOptions.sniffInterval = getDurationAsMs(config.sniffInterval);
}

// TODO: this can either be done globally here or by host in convertHost.
// Not sure which option is the best.
if (config.username && config.password) {
clientOptions.auth = {
username: config.username,
password: config.password,
};
}

clientOptions.nodes = config.hosts.map((host) => convertHost(host, !scoped, config));

if (config.ssl) {
clientOptions.ssl = generateSslConfig(
config.ssl,
scoped && !config.ssl.alwaysPresentCertificate
);
}

return clientOptions;
}

const generateSslConfig = (
sslConfig: Required<ElasticsearchClientConfig>['ssl'],
ignoreCertAndKey: boolean
): TlsConnectionOptions => {
const ssl: TlsConnectionOptions = {
ca: sslConfig.certificateAuthorities,
};

const verificationMode = sslConfig.verificationMode;
switch (verificationMode) {
case 'none':
ssl.rejectUnauthorized = false;
break;
case 'certificate':
ssl.rejectUnauthorized = true;
// by default, NodeJS is checking the server identify
ssl.checkServerIdentity = () => undefined;
break;
case 'full':
ssl.rejectUnauthorized = true;
break;
default:
throw new Error(`Unknown ssl verificationMode: ${verificationMode}`);
}

// Add client certificate and key if required by elasticsearch
if (!ignoreCertAndKey && sslConfig.certificate && sslConfig.key) {
ssl.cert = sslConfig.certificate;
ssl.key = sslConfig.key;
ssl.passphrase = sslConfig.keyPassphrase;
}

return ssl;
};

const convertHost = (
host: string,
needAuth: boolean,
{ username, password }: ElasticsearchClientConfig
): NodeOptions => {
const url = new URL(host);
const isHTTPS = url.protocol === 'https:';
url.port = url.port ?? isHTTPS ? '443' : '80';
if (needAuth && username && password) {
url.username = username;
url.password = password;
}

return {
url,
};
};

const getDurationAsMs = (duration: number | Duration) =>
typeof duration === 'number' ? duration : duration.asMilliseconds();
Loading