Skip to content

Commit

Permalink
Merge branch 'master' into so-types
Browse files Browse the repository at this point in the history
  • Loading branch information
mshustov committed Feb 21, 2020
2 parents 2acfc3e + 68e79e4 commit 0754f63
Show file tree
Hide file tree
Showing 901 changed files with 12,063 additions and 12,624 deletions.
6 changes: 1 addition & 5 deletions .ci/Jenkinsfile_coverage
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,7 @@ stage("Kibana Pipeline") { // This stage is just here to help the BlueOcean UI a
]) {
parallel([
'kibana-intake-agent': {
withEnv([
'NODE_ENV=test' // Needed for jest tests only
]) {
kibanaPipeline.intakeWorker('kibana-intake', './test/scripts/jenkins_unit.sh')()
}
kibanaPipeline.intakeWorker('kibana-intake', './test/scripts/jenkins_unit.sh')()
},
'x-pack-intake-agent': {
withEnv([
Expand Down
9 changes: 9 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@
/src/plugins/ui_actions/ @elastic/kibana-app-arch
/src/plugins/visualizations/ @elastic/kibana-app-arch
/x-pack/plugins/advanced_ui_actions/ @elastic/kibana-app-arch
/x-pack/plugins/drilldowns/ @elastic/kibana-app-arch

# APM
/x-pack/legacy/plugins/apm/ @elastic/apm-ui
Expand All @@ -75,6 +76,7 @@
/x-pack/plugins/ingest_manager/ @elastic/ingest
/x-pack/legacy/plugins/ingest_manager/ @elastic/ingest
/x-pack/plugins/observability/ @elastic/logs-metrics-ui @elastic/apm-ui @elastic/uptime @elastic/ingest
/x-pack/legacy/plugins/monitoring/ @elastic/stack-monitoring-ui

# Machine Learning
/x-pack/legacy/plugins/ml/ @elastic/ml-ui
Expand Down Expand Up @@ -184,3 +186,10 @@
/x-pack/test/api_integration/apis/endpoint/ @elastic/endpoint-app-team
/x-pack/test/functional/apps/endpoint/ @elastic/endpoint-app-team
/x-pack/test/functional/es_archives/endpoint/ @elastic/endpoint-app-team

# SIEM
/x-pack/legacy/plugins/siem/ @elastic/siem
/x-pack/plugins/siem/ @elastic/siem
/x-pack/test/detection_engine_api_integration @elastic/siem
/x-pack/test/api_integration/apis/siem @elastic/siem
/x-pack/plugins/case @elastic/siem
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,5 @@ export interface IBasePath
| [get](./kibana-plugin-public.ibasepath.get.md) | <code>() =&gt; string</code> | Gets the <code>basePath</code> string. |
| [prepend](./kibana-plugin-public.ibasepath.prepend.md) | <code>(url: string) =&gt; string</code> | Prepends <code>path</code> with the basePath. |
| [remove](./kibana-plugin-public.ibasepath.remove.md) | <code>(url: string) =&gt; string</code> | Removes the prepended basePath from the <code>path</code>. |
| [serverBasePath](./kibana-plugin-public.ibasepath.serverbasepath.md) | <code>string</code> | Returns the server's root basePath as configured, without any namespace prefix.<!-- -->See for getting the basePath value for a specific request |

Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IBasePath](./kibana-plugin-public.ibasepath.md) &gt; [serverBasePath](./kibana-plugin-public.ibasepath.serverbasepath.md)

## IBasePath.serverBasePath property

Returns the server's root basePath as configured, without any namespace prefix.

See for getting the basePath value for a specific request

<b>Signature:</b>

```typescript
readonly serverBasePath: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpFetchError](./kibana-plugin-public.ihttpfetcherror.md) &gt; [name](./kibana-plugin-public.ihttpfetcherror.name.md)

## IHttpFetchError.name property

<b>Signature:</b>

```typescript
readonly name: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [(constructor)](./kibana-plugin-server.elasticsearchconfig._constructor_.md)

## ElasticsearchConfig.(constructor)

Constructs a new instance of the `ElasticsearchConfig` class

<b>Signature:</b>

```typescript
constructor(rawConfig: ElasticsearchConfigType);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| rawConfig | <code>ElasticsearchConfigType</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [apiVersion](./kibana-plugin-server.elasticsearchconfig.apiversion.md)

## ElasticsearchConfig.apiVersion property

Version of the Elasticsearch (6.7, 7.1 or `master`<!-- -->) client will be connecting to.

<b>Signature:</b>

```typescript
readonly apiVersion: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [customHeaders](./kibana-plugin-server.elasticsearchconfig.customheaders.md)

## ElasticsearchConfig.customHeaders property

Header names and values to send to Elasticsearch with every request. These headers cannot be overwritten by client-side headers and aren't affected by `requestHeadersWhitelist` configuration.

<b>Signature:</b>

```typescript
readonly customHeaders: ElasticsearchConfigType['customHeaders'];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [healthCheckDelay](./kibana-plugin-server.elasticsearchconfig.healthcheckdelay.md)

## ElasticsearchConfig.healthCheckDelay property

The interval between health check requests Kibana sends to the Elasticsearch.

<b>Signature:</b>

```typescript
readonly healthCheckDelay: Duration;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [hosts](./kibana-plugin-server.elasticsearchconfig.hosts.md)

## ElasticsearchConfig.hosts property

Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster.

<b>Signature:</b>

```typescript
readonly hosts: string[];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [ignoreVersionMismatch](./kibana-plugin-server.elasticsearchconfig.ignoreversionmismatch.md)

## ElasticsearchConfig.ignoreVersionMismatch property

Whether to allow kibana to connect to a non-compatible elasticsearch node.

<b>Signature:</b>

```typescript
readonly ignoreVersionMismatch: boolean;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [logQueries](./kibana-plugin-server.elasticsearchconfig.logqueries.md)

## ElasticsearchConfig.logQueries property

Specifies whether all queries to the client should be logged (status code, method, query etc.).

<b>Signature:</b>

```typescript
readonly logQueries: boolean;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md)

## ElasticsearchConfig class

Wrapper of config schema.

<b>Signature:</b>

```typescript
export declare class ElasticsearchConfig
```

## Constructors

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(rawConfig)](./kibana-plugin-server.elasticsearchconfig._constructor_.md) | | Constructs a new instance of the <code>ElasticsearchConfig</code> class |

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [apiVersion](./kibana-plugin-server.elasticsearchconfig.apiversion.md) | | <code>string</code> | Version of the Elasticsearch (6.7, 7.1 or <code>master</code>) client will be connecting to. |
| [customHeaders](./kibana-plugin-server.elasticsearchconfig.customheaders.md) | | <code>ElasticsearchConfigType['customHeaders']</code> | Header names and values to send to Elasticsearch with every request. These headers cannot be overwritten by client-side headers and aren't affected by <code>requestHeadersWhitelist</code> configuration. |
| [healthCheckDelay](./kibana-plugin-server.elasticsearchconfig.healthcheckdelay.md) | | <code>Duration</code> | The interval between health check requests Kibana sends to the Elasticsearch. |
| [hosts](./kibana-plugin-server.elasticsearchconfig.hosts.md) | | <code>string[]</code> | Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster. |
| [ignoreVersionMismatch](./kibana-plugin-server.elasticsearchconfig.ignoreversionmismatch.md) | | <code>boolean</code> | Whether to allow kibana to connect to a non-compatible elasticsearch node. |
| [logQueries](./kibana-plugin-server.elasticsearchconfig.logqueries.md) | | <code>boolean</code> | Specifies whether all queries to the client should be logged (status code, method, query etc.). |
| [password](./kibana-plugin-server.elasticsearchconfig.password.md) | | <code>string</code> | If Elasticsearch is protected with basic authentication, this setting provides the password that the Kibana server uses to perform its administrative functions. |
| [pingTimeout](./kibana-plugin-server.elasticsearchconfig.pingtimeout.md) | | <code>Duration</code> | Timeout after which PING HTTP request will be aborted and retried. |
| [requestHeadersWhitelist](./kibana-plugin-server.elasticsearchconfig.requestheaderswhitelist.md) | | <code>string[]</code> | List of Kibana client-side headers to send to Elasticsearch when request scoped cluster client is used. If this is an empty array then \*no\* client-side will be sent. |
| [requestTimeout](./kibana-plugin-server.elasticsearchconfig.requesttimeout.md) | | <code>Duration</code> | Timeout after which HTTP request will be aborted and retried. |
| [shardTimeout](./kibana-plugin-server.elasticsearchconfig.shardtimeout.md) | | <code>Duration</code> | Timeout for Elasticsearch to wait for responses from shards. Set to 0 to disable. |
| [sniffInterval](./kibana-plugin-server.elasticsearchconfig.sniffinterval.md) | | <code>false &#124; Duration</code> | Interval to perform a sniff operation and make sure the list of nodes is complete. If <code>false</code> then sniffing is disabled. |
| [sniffOnConnectionFault](./kibana-plugin-server.elasticsearchconfig.sniffonconnectionfault.md) | | <code>boolean</code> | Specifies whether the client should immediately sniff for a more current list of nodes when a connection dies. |
| [sniffOnStart](./kibana-plugin-server.elasticsearchconfig.sniffonstart.md) | | <code>boolean</code> | Specifies whether the client should attempt to detect the rest of the cluster when it is first instantiated. |
| [ssl](./kibana-plugin-server.elasticsearchconfig.ssl.md) | | <code>Pick&lt;SslConfigSchema, Exclude&lt;keyof SslConfigSchema, 'certificateAuthorities' &#124; 'keystore' &#124; 'truststore'&gt;&gt; &amp; {</code><br/><code> certificateAuthorities?: string[];</code><br/><code> }</code> | Set of settings configure SSL connection between Kibana and Elasticsearch that are required when <code>xpack.ssl.verification_mode</code> in Elasticsearch is set to either <code>certificate</code> or <code>full</code>. |
| [username](./kibana-plugin-server.elasticsearchconfig.username.md) | | <code>string</code> | If Elasticsearch is protected with basic authentication, this setting provides the username that the Kibana server uses to perform its administrative functions. |

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [password](./kibana-plugin-server.elasticsearchconfig.password.md)

## ElasticsearchConfig.password property

If Elasticsearch is protected with basic authentication, this setting provides the password that the Kibana server uses to perform its administrative functions.

<b>Signature:</b>

```typescript
readonly password?: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [pingTimeout](./kibana-plugin-server.elasticsearchconfig.pingtimeout.md)

## ElasticsearchConfig.pingTimeout property

Timeout after which PING HTTP request will be aborted and retried.

<b>Signature:</b>

```typescript
readonly pingTimeout: Duration;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [requestHeadersWhitelist](./kibana-plugin-server.elasticsearchconfig.requestheaderswhitelist.md)

## ElasticsearchConfig.requestHeadersWhitelist property

List of Kibana client-side headers to send to Elasticsearch when request scoped cluster client is used. If this is an empty array then \*no\* client-side will be sent.

<b>Signature:</b>

```typescript
readonly requestHeadersWhitelist: string[];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [requestTimeout](./kibana-plugin-server.elasticsearchconfig.requesttimeout.md)

## ElasticsearchConfig.requestTimeout property

Timeout after which HTTP request will be aborted and retried.

<b>Signature:</b>

```typescript
readonly requestTimeout: Duration;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [shardTimeout](./kibana-plugin-server.elasticsearchconfig.shardtimeout.md)

## ElasticsearchConfig.shardTimeout property

Timeout for Elasticsearch to wait for responses from shards. Set to 0 to disable.

<b>Signature:</b>

```typescript
readonly shardTimeout: Duration;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [sniffInterval](./kibana-plugin-server.elasticsearchconfig.sniffinterval.md)

## ElasticsearchConfig.sniffInterval property

Interval to perform a sniff operation and make sure the list of nodes is complete. If `false` then sniffing is disabled.

<b>Signature:</b>

```typescript
readonly sniffInterval: false | Duration;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [sniffOnConnectionFault](./kibana-plugin-server.elasticsearchconfig.sniffonconnectionfault.md)

## ElasticsearchConfig.sniffOnConnectionFault property

Specifies whether the client should immediately sniff for a more current list of nodes when a connection dies.

<b>Signature:</b>

```typescript
readonly sniffOnConnectionFault: boolean;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [sniffOnStart](./kibana-plugin-server.elasticsearchconfig.sniffonstart.md)

## ElasticsearchConfig.sniffOnStart property

Specifies whether the client should attempt to detect the rest of the cluster when it is first instantiated.

<b>Signature:</b>

```typescript
readonly sniffOnStart: boolean;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [ssl](./kibana-plugin-server.elasticsearchconfig.ssl.md)

## ElasticsearchConfig.ssl property

Set of settings configure SSL connection between Kibana and Elasticsearch that are required when `xpack.ssl.verification_mode` in Elasticsearch is set to either `certificate` or `full`<!-- -->.

<b>Signature:</b>

```typescript
readonly ssl: Pick<SslConfigSchema, Exclude<keyof SslConfigSchema, 'certificateAuthorities' | 'keystore' | 'truststore'>> & {
certificateAuthorities?: string[];
};
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) &gt; [username](./kibana-plugin-server.elasticsearchconfig.username.md)

## ElasticsearchConfig.username property

If Elasticsearch is protected with basic authentication, this setting provides the username that the Kibana server uses to perform its administrative functions.

<b>Signature:</b>

```typescript
readonly username?: string;
```
1 change: 1 addition & 0 deletions docs/development/core/server/kibana-plugin-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [BasePath](./kibana-plugin-server.basepath.md) | Access or manipulate the Kibana base path |
| [ClusterClient](./kibana-plugin-server.clusterclient.md) | Represents an Elasticsearch cluster API client created by the platform. It allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via <code>asScoped(...)</code>).<!-- -->See [ClusterClient](./kibana-plugin-server.clusterclient.md)<!-- -->. |
| [CspConfig](./kibana-plugin-server.cspconfig.md) | CSP configuration for use in Kibana. |
| [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) | Wrapper of config schema. |
| [ElasticsearchErrorHelpers](./kibana-plugin-server.elasticsearcherrorhelpers.md) | Helpers for working with errors returned from the Elasticsearch service.Since the internal data of errors are subject to change, consumers of the Elasticsearch service should always use these helpers to classify errors instead of checking error internals such as <code>body.error.header[WWW-Authenticate]</code> |
| [KibanaRequest](./kibana-plugin-server.kibanarequest.md) | Kibana specific abstraction for an incoming request. |
| [RouteValidationError](./kibana-plugin-server.routevalidationerror.md) | Error to return when the validation is not successful. |
Expand Down
3 changes: 0 additions & 3 deletions docs/management/advanced-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,6 @@ into the document when displaying it.
`metrics:max_buckets`:: The maximum numbers of buckets that a single
data source can return. This might arise when the user selects a
short interval (for example, 1s) for a long time period (1 year).
`pageNavigation`:: The style of navigation menu for Kibana.
Choices are Individual, the legacy style where every plugin is represented in the nav,
and Grouped, a new format that bundles related plugins together in nested navigation.
`query:allowLeadingWildcards`:: Allows a wildcard (*) as the first character
in a query clause. Only applies when experimental query features are
enabled in the query bar. To disallow leading wildcards in Lucene queries,
Expand Down
Loading

0 comments on commit 0754f63

Please sign in to comment.