github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.13] Add `http.payloadTimeout` config option (#177309) (#177574)

Browse source 
# Backport

This will backport the following commits from `main` to `8.13`:
- [Add `http.payloadTimeout` config option
(#177309)](https://github.com/elastic/kibana/pull/177309)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Pierre
Gayvallet","email":"pierre.gayvallet@elastic.co"},"sourceCommit":{"committedDate":"2024-02-22T11:33:49Z","message":"Add
`http.payloadTimeout` config option (#177309)\n\n## Summary\r\n\r\nFix
https://github.com/elastic/kibana/issues/177138\r\n\r\n- Add a
`http.payloadTimeout` configuration option, to control the\r\npayload
timeout\r\n- Set the default value for this option to `20s` (was `10s`
previously)","sha":"38a3b9675d5fd7ab97b9b7a6394df67a4074de01","branchLabelMapping":{"^v8.14.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:http","Team:Core","release_note:skip","v8.13.0","v8.14.0"],"title":"Add
`http.payloadTimeout` config
option","number":177309,"url":"https://github.com/elastic/kibana/pull/177309","mergeCommit":{"message":"Add
`http.payloadTimeout` config option (#177309)\n\n## Summary\r\n\r\nFix
https://github.com/elastic/kibana/issues/177138\r\n\r\n- Add a
`http.payloadTimeout` configuration option, to control the\r\npayload
timeout\r\n- Set the default value for this option to `20s` (was `10s`
previously)","sha":"38a3b9675d5fd7ab97b9b7a6394df67a4074de01"}},"sourceBranch":"main","suggestedTargetBranches":["8.13"],"targetPullRequestStates":[{"branch":"8.13","label":"v8.13.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.14.0","branchLabelMappingKey":"^v8.14.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/177309","number":177309,"mergeCommit":{"message":"Add
`http.payloadTimeout` config option (#177309)\n\n## Summary\r\n\r\nFix
https://github.com/elastic/kibana/issues/177138\r\n\r\n- Add a
`http.payloadTimeout` configuration option, to control the\r\npayload
timeout\r\n- Set the default value for this option to `20s` (was `10s`
previously)","sha":"38a3b9675d5fd7ab97b9b7a6394df67a4074de01"}}]}]
BACKPORT-->

Co-authored-by: Pierre Gayvallet <pierre.gayvallet@elastic.co>
This commit is contained in:
Kibana Machine 2024-02-22 07:57:54 -05:00 • committed by GitHub
parent f733bdb2a7
commit 9a2f84146d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 46 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/setup/settings.asciidoc
View file

@ -467,6 +467,11 @@ default is `true`. *Default: `deprecated`*
The number of milliseconds to wait before closing an
inactive socket. *Default: `"120000"`*
[[server-payloadTimeout]] `server.payloadTimeout`::
Sets the maximum time allowed for the client to transmit the request payload (body) before giving up
and responding with a Request Timeout (408) error response.
*Default: `"20000"`*
[[server-ssl-cert-key]] `server.ssl.certificate` and `server.ssl.key`::
Paths to a PEM-encoded X.509 server certificate and its corresponding private key. These
are used by {kib} to establish trust when receiving inbound SSL/TLS connections from users.

1
packages/core/http/core-http-server-internal/src/__snapshots__/http_config.test.ts.snap generated
View file

@ -73,6 +73,7 @@ Object {
"valueInBytes": 1048576,
},
"name": "kibana-hostname",
"payloadTimeout": 20000,
"port": 5601,
"requestId": Object {
"allowFromAnyIp": false,

8
packages/core/http/core-http-server-internal/src/http_config.test.ts
View file

@ -349,6 +349,14 @@ test('can specify socket timeouts', () => {
expect(socketTimeout).toBe(5e5);
});
test('can specify payload timeouts', () => {
const obj = {
payloadTimeout: 654321,
};
const { payloadTimeout } = config.schema.validate(obj);
expect(payloadTimeout).toBe(654321);
});
describe('with compression', () => {
test('accepts valid referrer whitelist', () => {
const {

11
packages/core/http/core-http-server-internal/src/http_config.ts
View file

@ -26,6 +26,8 @@ import {
} from './security_response_headers_config';
import { CdnConfig } from './cdn_config';
const SECOND = 1000;
const validBasePathRegex = /^\/.*[^\/]$/;
const hostURISchema = schema.uri({ scheme: ['http', 'https'] });
@ -129,10 +131,13 @@ const configSchema = schema.object(
rewriteBasePath: schema.boolean({ defaultValue: false }),
ssl: sslSchema,
keepaliveTimeout: schema.number({
defaultValue: 120000,
defaultValue: 120 * SECOND,
}),
socketTimeout: schema.number({
defaultValue: 120000,
defaultValue: 120 * SECOND,
}),
payloadTimeout: schema.number({
defaultValue: 20 * SECOND,
}),
compression: schema.object({
enabled: schema.boolean({ defaultValue: true }),
@ -278,6 +283,7 @@ export class HttpConfig implements IHttpConfig {
public host: string;
public keepaliveTimeout: number;
public socketTimeout: number;
public payloadTimeout: number;
public port: number;
public cors: {
enabled: boolean;
@ -342,6 +348,7 @@ export class HttpConfig implements IHttpConfig {
this.publicBaseUrl = rawHttpConfig.publicBaseUrl;
this.keepaliveTimeout = rawHttpConfig.keepaliveTimeout;
this.socketTimeout = rawHttpConfig.socketTimeout;
this.payloadTimeout = rawHttpConfig.payloadTimeout;
this.rewriteBasePath = rawHttpConfig.rewriteBasePath;
this.ssl = new SslConfig(rawHttpConfig.ssl || {});
this.compression = rawHttpConfig.compression;

5
packages/kbn-cli-dev-mode/src/config/http_config.ts
View file

@ -30,6 +30,9 @@ export const httpConfigSchema = schema.object(
socketTimeout: schema.number({
defaultValue: 120000,
}),
payloadTimeout: schema.number({
defaultValue: 20000,
}),
cors: schema.object({
enabled: schema.boolean({ defaultValue: false }),
allowCredentials: schema.boolean({ defaultValue: false }),
@ -53,6 +56,7 @@ export class HttpConfig implements IHttpConfig {
shutdownTimeout: Duration;
keepaliveTimeout: number;
socketTimeout: number;
payloadTimeout: number;
cors: ICorsConfig;
ssl: ISslConfig;
restrictInternalApis: boolean;
@ -64,6 +68,7 @@ export class HttpConfig implements IHttpConfig {
this.maxPayload = rawConfig.maxPayload;
this.shutdownTimeout = rawConfig.shutdownTimeout;
this.keepaliveTimeout = rawConfig.keepaliveTimeout;
this.payloadTimeout = rawConfig.payloadTimeout;
this.socketTimeout = rawConfig.socketTimeout;
this.cors = rawConfig.cors;
this.ssl = new SslConfig(rawConfig.ssl);

1
packages/kbn-cli-dev-mode/src/integration_tests/base_path_proxy_server.test.ts
View file

@ -39,6 +39,7 @@ describe('BasePathProxyServer', () => {
shutdownTimeout: moment.duration(30, 'seconds'),
keepaliveTimeout: 1000,
socketTimeout: 1000,
payloadTimeout: 1000,
cors: {
enabled: false,
allowCredentials: false,

1
packages/kbn-health-gateway-server/src/server/server_config.test.ts
View file

@ -19,6 +19,7 @@ describe('server config', () => {
"maxPayload": ByteSizeValue {
"valueInBytes": 1048576,
},
"payloadTimeout": 20000,
"port": 3000,
"restrictInternalApis": false,
"shutdownTimeout": "PT30S",

5
packages/kbn-health-gateway-server/src/server/server_config.ts
View file

@ -27,6 +27,9 @@ const configSchema = schema.object(
keepaliveTimeout: schema.number({
defaultValue: 120000,
}),
payloadTimeout: schema.number({
defaultValue: 20000,
}),
shutdownTimeout: schema.duration({
defaultValue: '30s',
validate: (duration) => {
@ -73,6 +76,7 @@ export class ServerConfig implements IHttpConfig {
keepaliveTimeout: number;
shutdownTimeout: Duration;
socketTimeout: number;
payloadTimeout: number;
ssl: ISslConfig;
cors: ICorsConfig;
restrictInternalApis: boolean;
@ -84,6 +88,7 @@ export class ServerConfig implements IHttpConfig {
this.keepaliveTimeout = rawConfig.keepaliveTimeout;
this.shutdownTimeout = rawConfig.shutdownTimeout;
this.socketTimeout = rawConfig.socketTimeout;
this.payloadTimeout = rawConfig.payloadTimeout;
this.ssl = new SslConfig(rawConfig.ssl);
this.cors = {
enabled: false,

9
packages/kbn-server-http-tools/src/get_server_options.test.ts
View file

@ -25,6 +25,7 @@ const createConfig = (parts: Partial<IHttpConfig>): IHttpConfig => ({
port: 5601,
socketTimeout: 120000,
keepaliveTimeout: 120000,
payloadTimeout: 20000,
shutdownTimeout: moment.duration(30, 'seconds'),
maxPayload: ByteSizeValue.parse('1048576b'),
...parts,
@ -122,4 +123,12 @@ describe('getServerOptions', () => {
headers: ['Accept', 'Authorization', 'Content-Type', 'If-None-Match', 'kbn-xsrf'],
});
});
it('properly configures `routes.payload.timeout`', () => {
const httpConfig = createConfig({
payloadTimeout: 9007,
});
expect(getServerOptions(httpConfig).routes!.payload!.timeout).toEqual(9007);
});
});

1
packages/kbn-server-http-tools/src/get_server_options.ts
View file

@ -35,6 +35,7 @@ export function getServerOptions(config: IHttpConfig, { configureTLS = true } =
cors,
payload: {
maxBytes: config.maxPayload.getValueInBytes(),
timeout: config.payloadTimeout,
},
validate: {
failAction: defaultValidationErrorHandler,

1
packages/kbn-server-http-tools/src/types.ts
View file

@ -15,6 +15,7 @@ export interface IHttpConfig {
maxPayload: ByteSizeValue;
keepaliveTimeout: number;
socketTimeout: number;
payloadTimeout: number;
cors: ICorsConfig;
ssl: ISslConfig;
shutdownTimeout: Duration;