Skip to content

Commit

Permalink
Merge branch 'master' into usage_collection/remove-unused-ui_metric-apis
Browse files Browse the repository at this point in the history
  • Loading branch information
kibanamachine authored Feb 24, 2021
2 parents 7c9c2dd + d2abc03 commit 39d3f63
Show file tree
Hide file tree
Showing 369 changed files with 3,533 additions and 2,815 deletions.
3 changes: 2 additions & 1 deletion .ci/Jenkinsfile_security_cypress
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ kibanaPipeline(timeoutMinutes: 180) {
workers.ci(name: job, size: 'l', ramDisk: true) {
kibanaPipeline.bash('test/scripts/jenkins_xpack_build_kibana.sh', 'Build Default Distributable')
kibanaPipeline.functionalTestProcess(job, 'test/scripts/jenkins_security_solution_cypress_chrome.sh')()
kibanaPipeline.functionalTestProcess(job, 'test/scripts/jenkins_security_solution_cypress_firefox.sh')()
// Temporarily disabled to figure out test flake
// kibanaPipeline.functionalTestProcess(job, 'test/scripts/jenkins_security_solution_cypress_firefox.sh')()
}
}
}
Expand Down
54 changes: 20 additions & 34 deletions .ci/es-snapshots/Jenkinsfile_verify_es
Original file line number Diff line number Diff line change
Expand Up @@ -30,38 +30,22 @@ kibanaPipeline(timeoutMinutes: 210) {
"ES_SNAPSHOT_MANIFEST=${SNAPSHOT_MANIFEST}",
'IGNORE_SHIP_CI_STATS_ERROR=true',
]) {
parallel([
'kibana-intake-agent': workers.intake('kibana-intake', './test/scripts/jenkins_unit.sh'),
'kibana-oss-agent': workers.functional('kibana-oss-tests', { kibanaPipeline.buildOss() }, [
'oss-ciGroup1': kibanaPipeline.ossCiGroupProcess(1),
'oss-ciGroup2': kibanaPipeline.ossCiGroupProcess(2),
'oss-ciGroup3': kibanaPipeline.ossCiGroupProcess(3),
'oss-ciGroup4': kibanaPipeline.ossCiGroupProcess(4),
'oss-ciGroup5': kibanaPipeline.ossCiGroupProcess(5),
'oss-ciGroup6': kibanaPipeline.ossCiGroupProcess(6),
'oss-ciGroup7': kibanaPipeline.ossCiGroupProcess(7),
'oss-ciGroup8': kibanaPipeline.ossCiGroupProcess(8),
'oss-ciGroup9': kibanaPipeline.ossCiGroupProcess(9),
'oss-ciGroup10': kibanaPipeline.ossCiGroupProcess(10),
'oss-ciGroup11': kibanaPipeline.ossCiGroupProcess(11),
'oss-ciGroup12': kibanaPipeline.ossCiGroupProcess(12),
]),
'kibana-xpack-agent': workers.functional('kibana-xpack-tests', { kibanaPipeline.buildXpack() }, [
'xpack-ciGroup1': kibanaPipeline.xpackCiGroupProcess(1),
'xpack-ciGroup2': kibanaPipeline.xpackCiGroupProcess(2),
'xpack-ciGroup3': kibanaPipeline.xpackCiGroupProcess(3),
'xpack-ciGroup4': kibanaPipeline.xpackCiGroupProcess(4),
'xpack-ciGroup5': kibanaPipeline.xpackCiGroupProcess(5),
'xpack-ciGroup6': kibanaPipeline.xpackCiGroupProcess(6),
'xpack-ciGroup7': kibanaPipeline.xpackCiGroupProcess(7),
'xpack-ciGroup8': kibanaPipeline.xpackCiGroupProcess(8),
'xpack-ciGroup9': kibanaPipeline.xpackCiGroupProcess(9),
'xpack-ciGroup10': kibanaPipeline.xpackCiGroupProcess(10),
'xpack-ciGroup11': kibanaPipeline.xpackCiGroupProcess(11),
'xpack-ciGroup12': kibanaPipeline.xpackCiGroupProcess(12),
'xpack-ciGroup13': kibanaPipeline.xpackCiGroupProcess(13),
]),
])
kibanaPipeline.withTasks {
tasks([
kibanaPipeline.scriptTaskDocker('Jest Integration Tests', 'test/scripts/test/jest_integration.sh'),
kibanaPipeline.scriptTask('API Integration Tests', 'test/scripts/test/api_integration.sh'),
])

task {
kibanaPipeline.buildOss(6)
tasks.ossCiGroups()
}

task {
kibanaPipeline.buildXpack(10)
tasks.xpackCiGroups()
}
}
}

promoteSnapshot(SNAPSHOT_VERSION, SNAPSHOT_ID)
Expand All @@ -72,7 +56,9 @@ kibanaPipeline(timeoutMinutes: 210) {
}

def promoteSnapshot(snapshotVersion, snapshotId) {
node(workers.label('s')) {
esSnapshots.promote(snapshotVersion, snapshotId)
if (buildUtils.getBuildStatus() == 'SUCCESS') {
node(workers.label('s')) {
esSnapshots.promote(snapshotVersion, snapshotId)
}
}
}
2 changes: 1 addition & 1 deletion .node-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
14.15.4
14.16.0
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
14.15.4
14.16.0
2 changes: 2 additions & 0 deletions docs/api/actions-and-connectors/create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ Creates an action.
`secrets`::
(Required, object) The secrets configuration for the action. Secrets configuration properties vary
depending on the action type. For information about the secrets configuration properties, refer to <<action-types,Action and connector types>>.
+
WARNING: Remember these values. You must provide them each time you call the <<actions-and-connectors-api-update, update>> API.

[[actions-and-connectors-api-create-request-codes]]
==== Response code
Expand Down
8 changes: 7 additions & 1 deletion docs/api/alerts/create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ Create {kib} alerts.
[[alerts-api-create-request]]
==== Request

`POST <kibana host>:<port>/api/alerts/alert`
`POST <kibana host>:<port>/api/alerts/alert/<id>`

[[alerts-api-create-path-params]]
==== Path parameters

`<id>`::
(Optional, string) Specifies a UUID v1 or v4 to use instead of a randomly generated ID.

[[alerts-api-create-request-body]]
==== Request body
Expand Down
10 changes: 5 additions & 5 deletions docs/api/alerts/find.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@

Retrieve a paginated set of alerts based on condition.

NOTE: As alerts change in {kib}, the results on each page of the response also
change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data.

[[alerts-api-find-request]]
==== Request

Expand All @@ -14,6 +17,8 @@ Retrieve a paginated set of alerts based on condition.
[[alerts-api-find-query-params]]
==== Query Parameters

NOTE: Alert `params` are stored as a {ref}/flattened.html[flattened field type] and analyzed as keywords.

`per_page`::
(Optional, number) The number of alerts to return per page.

Expand Down Expand Up @@ -46,11 +51,6 @@ Retrieve a paginated set of alerts based on condition.
It should look like savedObjectType.attributes.title: "myTitle". However, If you used a direct attribute of a saved object, such as `updatedAt`,
you will have to define your filter, for example, savedObjectType.updatedAt > 2018-12-22.

NOTE: As alerts change in {kib}, the results on each page of the response also
change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data.

NOTE: Alert `params` are stored as {ref}/flattened.html[flattened] and analyzed as `keyword`.

[[alerts-api-find-request-codes]]
==== Response code

Expand Down
2 changes: 1 addition & 1 deletion docs/management/alerting/alert-management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
=== Managing Alerts


The *Alerts* tab provides a cross-app view of alerting. Different {kib} apps like <<metrics-app,Metrics>>, <<xpack-apm,APM>>, <<uptime-app,Uptime>>, and <<xpack-siem,SIEM>> can offer their own alerts, and the *Alerts* tab provides a central place to:
The *Alerts* tab provides a cross-app view of alerting. Different {kib} apps like {observability-guide}/create-alerts.html[*Observability*], {security-guide}/prebuilt-rules.html[*Security*], <<geo-alerting, *Maps*>> and <<xpack-ml, *Machine Learning*>> can offer their own alerts. The *Alerts* tab provides a central place to:

* <<create-edit-alerts, Create and edit>> alerts
* <<controlling-alerts, Control alerts>> including enabling/disabling, muting/unmuting, and deleting
Expand Down
13 changes: 5 additions & 8 deletions docs/management/index-patterns.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,10 @@ which indicates the type of data the field contains in {es},
such as strings or boolean values. The field mapping also determines
how you can use the field, such as whether it can be searched or aggregated.

When a new field is added to the index, the index pattern field list is updated
the next time the index pattern is loaded, for example, when you load the page or
move between {kib} apps.

[role="screenshot"]
image:management/index-patterns/images/new-index-pattern.png["Create index pattern"]

Expand All @@ -158,7 +162,7 @@ date values in {es}, you can use a {kib} field formatter to change the display t
<<field-formatters-geopoint, geopoints>>,
and <<field-formatters-numeric, numbers>>.

To customize the displayed field name provided by {es}, you can
To customize the displayed field name provided by {es}, you can
use *Custom Label* .

A popularity counter keeps track of the fields you use most often.
Expand All @@ -170,13 +174,6 @@ To edit the field display, click the edit icon
[role="screenshot"]
image:management/index-patterns/images/edit-field-format.png["Edit field format"]

[float]
==== Refresh the data fields

To pick up newly-added fields,
refresh (image:management/index-patterns/images/refresh-icon.png[Refresh icon]) the index fields list.
This action also resets the {kib} popularity counters for the fields.

[float]
[[default-index-pattern]]
=== Set the default index pattern
Expand Down
Binary file modified docs/management/index-patterns/images/new-index-pattern.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/user/alerting/action-types.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[action-types]]
== Action and connector types
== Actions and connectors

Actions are Kibana services or integrations with third-party systems that run as background tasks on the Kibana server when alert conditions are met. {kib} provides the following types of actions:

Expand Down
22 changes: 15 additions & 7 deletions docs/user/alerting/action-types/email.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,21 @@

The email action type uses the SMTP protocol to send mail message, using an integration of https://nodemailer.com/[Nodemailer]. Email message text is sent as both plain text and html text.

NOTE: For emails to have a footer with a link back to {kib}, set the <<server-publicBaseUrl, `server.publicBaseUrl`>> configuration setting.

[float]
[[email-connector-configuration]]
==== Connector configuration

Email connectors have the following configuration properties:

Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
Sender:: The from address for all emails sent with this connector, specified in `user@host-name` format.
Sender:: The from address for all emails sent with this connector. This can be specified in `user@host-name` format or as `"human name <user@host-name>"` format. See the https://nodemailer.com/message/addresses/[Nodemailer address documentation] for more information.
Host:: Host name of the service provider. If you are using the <<action-settings, `xpack.actions.allowedHosts`>> setting, make sure this hostname is added to the allowed hosts.
Port:: The port to connect to on the service provider.
Secure:: If true, the connection will use TLS when connecting to the service provider. Refer to the https://nodemailer.com/smtp/#tls-options[Nodemailer TLS documentation] for more information. If not true, the connection will initially connect over TCP, then attempt to switch to TLS via the SMTP STARTTLS command.
Username:: username for 'login' type authentication.
Password:: password for 'login' type authentication.
User:: Username for login type authentication.
Password:: Password for login type authentication.

[float]
[[Preconfigured-email-configuration]]
Expand All @@ -38,11 +40,14 @@ Password:: password for 'login' type authentication.
--

[[email-connector-config-properties]]
`config` defines the action type specific to the configuration and contains the following properties:
**`config`** defines the action type specific to the configuration and contains the following properties:

[cols="2*<"]
|===

| `service`
| The name of a https://nodemailer.com/smtp/well-known/[well-known email service provider]. If `service` is provided, `host`, `port`, and `secure` properties are ignored. For more information on the `gmail` service value, see the (https://nodemailer.com/usage/using-gmail/)[Nodemailer Gmail documentation].

| `from`
| An email address that corresponds to *Sender*.

Expand All @@ -55,18 +60,21 @@ Password:: password for 'login' type authentication.
| `secure`
| A boolean that corresponds to *Secure*.

| `hasAuth`
| If `true`, this connector will require values for `user` and `password` inside the secrets configuration. Defaults to `true`.

|===

`secrets` defines sensitive information for the action type:
**`secrets`** defines sensitive information for the action type and contains the following properties:

[cols="2*<"]
|===

| `user`
| A string that corresponds to *User*.
| A string that corresponds to *User*. Required if `hasAuth` is set to `true`.

| `password`
| A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>.
| A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>. Required if `hasAuth` is set to `true`.

|===

Expand Down
4 changes: 2 additions & 2 deletions docs/user/alerting/action-types/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Execution time field:: This field will be automatically set to the time the ale
--

[[index-connector-config-properties]]
`config` defines the action type specific to the configuration and contains the following properties:
**`config`** defines the action type specific to the configuration and contains the following properties:

[cols="2*<"]
|===
Expand All @@ -40,7 +40,7 @@ Execution time field:: This field will be automatically set to the time the ale
| A string that corresponds to *Index*.

|`refresh`
| A boolean that corresponds to *Refresh*.
| A boolean that corresponds to *Refresh*. Defaults to `false`.

|`executionTimeField`
| A string that corresponds to *Execution time field*.
Expand Down
50 changes: 40 additions & 10 deletions docs/user/alerting/action-types/jira.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ API token (or password):: Jira API authentication token (or password) for HTTP
--

[[jira-connector-config-properties]]
`config` defines the action type specific to the configuration and contains the following properties:
**`config`** defines the action type specific to the configuration and contains the following properties:

[cols="2*<"]
|===
Expand All @@ -47,7 +47,7 @@ API token (or password):: Jira API authentication token (or password) for HTTP

|===

`secrets` defines sensitive information for the action type:
**`secrets`** defines sensitive information for the action type and contains the following properties:

[cols="2*<"]
|===
Expand All @@ -65,14 +65,44 @@ API token (or password):: Jira API authentication token (or password) for HTTP

Jira actions have the following configuration properties:

Issue type:: The type of the issue.
Priority:: The priority of the incident.
Labels:: The labels of the incident.
Title:: A title for the issue, used for searching the contents of the knowledge base.
Description:: The details about the incident.
Parent:: The parent issue id or key. Only for `Sub-task` issue types.
Priority:: The priority of the incident.
Additional comments:: Additional information for the client, such as how to troubleshoot the issue.
Subaction:: The subaction to perform: `pushToService`, `getIncident`, `issueTypes`, `fieldsByIssueType`, `issues`, `issue`, or `getFields`.
Subaction params:: The parameters of the subaction.

==== `pushToService` subaction configuration

Incident:: A Jira incident has the following properties:
* `summary` - The title of the issue.
* `description` - A description of the issue.
* `externalId` - The ID of the issue in Jira. If present, the issue is updated. Otherwise, a new issue is created.
* `issueType` - The ID of the issue type in Jira.
* `priority` - The priority level in Jira. Example: `Medium`.
* `labels` - An array of labels. Labels cannot contain spaces.
* `parent` - The parent issue ID or key. Only for subtask issue types.
Comments:: A comment in the form of `{ commentId: string, version: string, comment: string }`.

==== `getIncident` subaction configuration

External ID:: The ID of the issue in Jira.

==== `issueTypes` subaction configuration

The `issueTypes` subaction has no parameters. Provide an empty object `{}`.

==== `fieldsByIssueType` subaction configuration

ID:: The ID of the issue in Jira.

==== `issues` subaction configuration

Title:: The title to search for.

==== `issue` subaction configuration

ID:: The ID of the issue in Jira.

==== `getFields` subaction configuration

The `getFields` subaction has no parameters. Provide an empty object `{}`.

[[configuring-jira]]
==== Configuring and testing Jira
Expand Down
23 changes: 17 additions & 6 deletions docs/user/alerting/action-types/pagerduty.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -151,14 +151,25 @@ Integration Key:: A 32 character PagerDuty Integration Key for an integration
--

[[pagerduty-connector-config-properties]]
`config` defines the action type specific to the configuration.
`config` contains
`apiURL`, a string that corresponds to *API URL*.
**`config`** defines the action type specific to the configuration and contains the following properties:

`secrets` defines sensitive information for the action type.
`secrets` contains
`routingKey`, a string that corresponds to *Integration Key*.
[cols="2*<"]
|===

|`apiURL`
| A URL string that corresponds to *API URL*.

|===

**`secrets`** defines sensitive information for the action type and contains the following properties:

[cols="2*<"]
|===

|`routingKey`
| A string that corresponds to *Integration Key*.

|===

[float]
[[pagerduty-action-configuration]]
Expand Down
Loading

0 comments on commit 39d3f63

Please sign in to comment.