-
Notifications
You must be signed in to change notification settings - Fork 8.2k
/
configure_client.ts
92 lines (83 loc) · 3.12 KB
/
configure_client.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/*
* 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 { Buffer } from 'buffer';
import { stringify } from 'querystring';
import { ApiError, Client, RequestEvent, errors } from '@elastic/elasticsearch';
import type { RequestBody } from '@elastic/elasticsearch/lib/Transport';
import { Logger } from '../../logging';
import { parseClientOptions, ElasticsearchClientConfig } from './client_config';
export const configureClient = (
config: ElasticsearchClientConfig,
{ logger, scoped = false }: { logger: Logger; scoped?: boolean }
): Client => {
const clientOptions = parseClientOptions(config, scoped);
const client = new Client(clientOptions);
addLogging(client, logger, config.logQueries);
return client;
};
const convertQueryString = (qs: string | Record<string, any> | undefined): string => {
if (qs === undefined || typeof qs === 'string') {
return qs ?? '';
}
return stringify(qs);
};
function ensureString(body: RequestBody): string {
if (typeof body === 'string') return body;
if (Buffer.isBuffer(body)) return '[buffer]';
if ('readable' in body && body.readable && typeof body._read === 'function') return '[stream]';
return JSON.stringify(body);
}
function getErrorMessage(error: ApiError, event: RequestEvent): string {
if (error instanceof errors.ResponseError) {
return `${getResponseMessage(event)} [${event.body?.error?.type}]: ${
event.body?.error?.reason ?? error.message
}`;
}
return `[${error.name}]: ${error.message}`;
}
/**
* returns a string in format:
*
* status code
* URL
* request body
*
* so it could be copy-pasted into the Dev console
*/
function getResponseMessage(event: RequestEvent): string {
const params = event.meta.request.params;
// definition is wrong, `params.querystring` can be either a string or an object
const querystring = convertQueryString(params.querystring);
const url = `${params.path}${querystring ? `?${querystring}` : ''}`;
const body = params.body ? `\n${ensureString(params.body)}` : '';
return `${event.statusCode}\n${params.method} ${url}${body}`;
}
const addLogging = (client: Client, logger: Logger, logQueries: boolean) => {
client.on('response', (error, event) => {
if (event && logQueries) {
if (error) {
logger.error(getErrorMessage(error, event));
} else {
logger.debug(getResponseMessage(event), {
tags: ['query'],
});
}
}
});
};