Skip to content

Commit

Permalink
Merge branch 'master' of github.com:elastic/kibana into feature/pipel…
Browse files Browse the repository at this point in the history
…ine-editor

* 'master' of github.com:elastic/kibana: (37 commits)
  [APM] Correct relative paths in scripts (#66159)
  [Uptime] Enable deselection of stale filters (#65523)
  [Drilldowns][chore] Remove some any's from components. Remove `PlaceContext` from components (#65854)
  [functional/services] import By/until from module (#66015)
  [Drilldowns][IE] fix welcome bar layout in IE (#65676)
  Inspect action shows on dashboard for every chart (#65998)
  Fix heigt calc in calc issue for ie11 (#66010)
  [Flights] Delay Bucket - Error notification on opening sample visualization (#66028)
  [SIEM] [Security] unified code structure phase 0 (#65965)
  [Maps] Organize layers into subfolders (#65513)
  skip flaky suite (#59849)
  Cleanup prefill and edit flow. (#66105)
  Fix major severity service map ring colors (#66124)
  [DOCS] Improves formatting in action types (#65932)
  [DOCS] APM Agent config: Setting values must be string (#65875)
  Change default cert age limit value. (#65918)
  [DOCS] Removed saved object options (#66072)
  [SIEM] [Cases] Case API tests (#65777)
  Add example of of local plugin installation (#65986)
  skip flaky suite (#65741)
  ...
  • Loading branch information
jloleysens committed May 12, 2020
2 parents 78b86ad + 3f43763 commit 6316956
Show file tree
Hide file tree
Showing 2,632 changed files with 96,262 additions and 92,555 deletions.
34 changes: 17 additions & 17 deletions docs/apm/api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The following Agent configuration APIs are available:
======

`settings`::
(required) Key/value object with settings and their corresponding value.
(required) Key/value object with option name and option value.

`agent_name`::
(optional) The agent name is used by the UI to determine which settings to display.
Expand All @@ -73,14 +73,14 @@ The following Agent configuration APIs are available:
--------------------------------------------------
PUT /api/apm/settings/agent-configuration
{
"service" : {
"name" : "frontend",
"environment" : "production"
"service": {
"name": "frontend",
"environment": "production"
},
"settings" : {
"transaction_sample_rate" : 0.4,
"capture_body" : "off",
"transaction_max_spans" : 500
"settings": {
"transaction_sample_rate": "0.4",
"capture_body": "off",
"transaction_max_spans": "500"
},
"agent_name": "nodejs"
}
Expand Down Expand Up @@ -124,7 +124,7 @@ PUT /api/apm/settings/agent-configuration
DELETE /api/apm/settings/agent-configuration
{
"service" : {
"name" : "frontend",
"name": "frontend",
"environment": "production"
}
}
Expand Down Expand Up @@ -157,9 +157,9 @@ DELETE /api/apm/settings/agent-configuration
"environment": "production"
},
"settings": {
"transaction_sample_rate": 1,
"transaction_sample_rate": "1",
"capture_body": "off",
"transaction_max_spans": 200
"transaction_max_spans": "200"
},
"@timestamp": 1581934104843,
"applied_by_agent": false,
Expand All @@ -171,9 +171,9 @@ DELETE /api/apm/settings/agent-configuration
"name": "opbeans-go"
},
"settings": {
"transaction_sample_rate": 1,
"transaction_sample_rate": "1",
"capture_body": "off",
"transaction_max_spans": 300
"transaction_max_spans": "300"
},
"@timestamp": 1581934111727,
"applied_by_agent": false,
Expand All @@ -185,7 +185,7 @@ DELETE /api/apm/settings/agent-configuration
"name": "frontend"
},
"settings": {
"transaction_sample_rate": 1,
"transaction_sample_rate": "1",
},
"@timestamp": 1582031336265,
"applied_by_agent": false,
Expand Down Expand Up @@ -250,7 +250,7 @@ GET /api/apm/settings/agent-configuration
"name": "frontend"
},
"settings": {
"transaction_sample_rate": 1,
"transaction_sample_rate": "1",
},
"@timestamp": 1582031336265,
"applied_by_agent": false,
Expand All @@ -266,9 +266,9 @@ GET /api/apm/settings/agent-configuration
--------------------------------------------------
POST /api/apm/settings/agent-configuration/search
{
"etag" : "1e58c178efeebae15c25c539da740d21dee422fc",
"etag": "1e58c178efeebae15c25c539da740d21dee422fc",
"service" : {
"name" : "frontend",
"name": "frontend",
"environment": "production"
}
}
Expand Down
2 changes: 1 addition & 1 deletion docs/canvas/canvas-elements.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ By default, most of the elements you create use demo data until you change the d
[[canvas-add-object]]
==== Add a saved object

Add a <<managing-saved-objects,saved object>>, such as a map or Lens visualization, then customize it to fit your display needs.
Add a <<managing-saved-objects,saved object>>, then customize it to fit your display needs.

. Click *Embed object*.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
fields?: {
[subfield: string]: {
type: string;
ignore_above?: number;
};
};
```
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export interface SavedObjectsCoreFieldMapping
| Property | Type | Description |
| --- | --- | --- |
| [enabled](./kibana-plugin-core-server.savedobjectscorefieldmapping.enabled.md) | <code>boolean</code> | |
| [fields](./kibana-plugin-core-server.savedobjectscorefieldmapping.fields.md) | <code>{</code><br/><code> [subfield: string]: {</code><br/><code> type: string;</code><br/><code> };</code><br/><code> }</code> | |
| [fields](./kibana-plugin-core-server.savedobjectscorefieldmapping.fields.md) | <code>{</code><br/><code> [subfield: string]: {</code><br/><code> type: string;</code><br/><code> ignore_above?: number;</code><br/><code> };</code><br/><code> }</code> | |
| [index](./kibana-plugin-core-server.savedobjectscorefieldmapping.index.md) | <code>boolean</code> | |
| [null\_value](./kibana-plugin-core-server.savedobjectscorefieldmapping.null_value.md) | <code>number &#124; boolean &#124; string</code> | |
| [type](./kibana-plugin-core-server.savedobjectscorefieldmapping.type.md) | <code>string</code> | |
Expand Down
6 changes: 3 additions & 3 deletions docs/user/alerting/action-types.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ see https://www.elastic.co/subscriptions[the subscription page].

[float]
[[create-connectors]]
=== Preconfigured connectors and action types
=== Preconfigured actions and connectors

For out-of-the-box and standardized connectors, you can <<preconfigured-connector-example, preconfigure connectors>>
For out-of-the-box and standardized connectors, you can <<preconfigured-connector-example, preconfigure the connector>>
before {kib} starts.

If you preconfigure a connector, you can also <<preconfigured-action-type-example, preconfigure its action type>>.
Expand All @@ -54,4 +54,4 @@ include::action-types/pagerduty.asciidoc[]
include::action-types/server-log.asciidoc[]
include::action-types/slack.asciidoc[]
include::action-types/webhook.asciidoc[]
include::pre-configured-connectors.asciidoc[]
include::action-types/pre-configured-connectors.asciidoc[]
45 changes: 32 additions & 13 deletions docs/user/alerting/action-types/email.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,27 +28,46 @@ Password:: password for 'login' type authentication.
name: preconfigured-email-action-type
actionTypeId: .email
config:
from: testsender@test.com <1.1>
host: validhostname <1.2>
port: 8080 <1.3>
secure: false <1.4>
from: testsender@test.com
host: validhostname
port: 8080
secure: false
secrets:
user: testuser <2.1>
password: passwordkeystorevalue <2.2>
user: testuser
password: passwordkeystorevalue
--

`config` defines the action type specific to the configuration and contains the following properties:

<1.1> `from:` is an email address and correspond to *Sender*.
<1.2> `host:` is a string and correspond to *Host*.
<1.3> `port:` is a number and correspond to *Port*.
<1.4> `secure:` is a boolean and correspond to *Secure*.
[cols="2*<"]
|===

`secrets` defines action type sensitive configuration:
| `from`
| An email address that corresponds to *Sender*.

<2.1> `user:` is a string and correspond to *User*.
<2.2> `password:` is a string and correspond to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>.
| `host`
| A string that corresponds to *Host*.

| `port`
| A number that corresponds to *Port*.

| `secure`
| A boolean that corresponds to *Secure*.

|===

`secrets` defines sensitive information for the action type:

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

| `user`
| A string that corresponds to *User*.

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

|===

[[email-action-configuration]]
==== Action configuration
Expand Down
22 changes: 16 additions & 6 deletions docs/user/alerting/action-types/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,26 @@ Execution time field:: This field will be automatically set to the time the ale
name: action-type-index
actionTypeId: .index
config:
index: .kibana <1>
refresh: true <2>
executionTimeField: somedate <3>
index: .kibana
refresh: true
executionTimeField: somedate
--

`config` defines the action type specific to the configuration and contains the following properties:

<1> `index:` is a string and correspond to *Index*.
<2> `refresh:` is a boolean and correspond to *Refresh*.
<3> `executionTimeField:` is a string and correspond to *Execution time field*.
[cols="2*<"]
|===

|`index`
| A string that corresponds to *Index*.

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

|`executionTimeField`
| A string that corresponds to *Execution time field*.

|===


[float]
Expand Down
15 changes: 8 additions & 7 deletions docs/user/alerting/action-types/pagerduty.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -145,18 +145,19 @@ Integration Key:: A 32 character PagerDuty Integration Key for an integration
name: preconfigured-pagerduty-action-type
actionTypeId: .pagerduty
config:
apiUrl: https://test.host <1.1>
apiUrl: https://test.host
secrets:
routingKey: testroutingkey <2.1>
routingKey: testroutingkey
--

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

<1.1> `apiUrl:` is URL string and correspond to *API URL*.
`secrets` defines sensitive information for the action type.
`secrets` contains
`routingKey`, a string that corresponds to *Integration Key*.

`secrets` defines action type sensitive configuration:

<2.1> `routingKey:` is a string and correspond to *Integration Key*.

[float]
[[pagerduty-action-configuration]]
Expand Down
121 changes: 121 additions & 0 deletions docs/user/alerting/action-types/pre-configured-connectors.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
[role="xpack"]
[[pre-configured-action-types-and-connectors]]

=== Preconfigured connectors and action types

You can preconfigure a connector or action type to have all the information it needs prior to startup
by adding it to the `kibana.yml` file.

Preconfigured connectors offer the following capabilities:

- Require no setup. Configuration and credentials needed to execute an
action are predefined, including the connector name and ID.
- Appear in all spaces because they are not saved objects.
- Cannot be edited or deleted.

A preconfigured action type has only preconfigured connectors. Preconfigured
connectors can belong to either the preconfigured action type or to the regular action type.

[float]
[[preconfigured-connector-example]]
==== Preconfigured connectors

This example shows a valid configuration for
two out-of-the box connectors: <<slack-action-type, Slack>> and <<webhook-action-type, Webhook>>.

```js
xpack.actions.preconfigured:
my-slack1: <1>
actionTypeId: .slack <2>
name: 'Slack #xyz' <3>
config: <4>
webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz'
webhook-service:
actionTypeId: .webhook
name: 'Email service'
config:
url: 'https://email-alert-service.elastic.co'
method: post
headers:
header1: value1
header2: value2
secrets: <5>
user: elastic
password: changeme
```

<1> The key is the action connector identifier, `my-slack1` in this example.
<2> `actionTypeId` is the action type identifier.
<3> `name` is the name of the preconfigured connector.
<4> `config` is the action type specific to the configuration.
<5> `secrets` is sensitive configuration, such as username, password, and keys.

[NOTE]
==============================================
Sensitive properties, such as passwords, can also be stored in the <<creating-keystore, {kib} keystore>>.
==============================================

////
[float]
[[managing-pre-configured-connectors]]
==== View preconfigured connectors
////

In *Management > Alerts and Actions*, preconfigured connectors
appear in the <<connector-management, *Connectors* tab>>,
regardless of which space you are in.
They are tagged as “preconfigured”, and you cannot delete them.

[role="screenshot"]
image::images/pre-configured-connectors-managing.png[Connectors managing tab with pre-cofigured]

Clicking a preconfigured connector shows the description, but not the configuration.
A message indicates that this is a preconfigured connector.

[role="screenshot"]
image::images/pre-configured-connectors-view-screen.png[Pre-configured connector view details]

The connector details preview is disabled for preconfigured connectors
of a preconfigured action type.

[role="screenshot"]
image::images/pre-configured-action-type-managing.png[Connectors managing tab with pre-cofigured]

[float]
[[preconfigured-action-type-example]]
==== Preconfigured action type

This example shows a preconfigured action type with one out-of-the box connector.

```js
xpack.actions.enabledActionTypes: ['.slack', '.email', '.index'] <1>
xpack.actions.preconfigured: <2>
my-server-log:
actionTypeId: .server-log
name: 'Server log #xyz'
```

<1> `enabledActionTypes` excludes the preconfigured action type to prevent creating and deleting connectors.
<2> `preconfigured` is the setting for defining the list of available connectors for the preconfigured action type.

[[managing-pre-configured-action-types]]
To attach a preconfigured action to an alert:

. In *Management > Alerts and Actions*, open the *Connectors* tab.

. Click *Create connector.*

. In the list of available action types, select the preconfigured action type you want.
+
[role="screenshot"]
image::images/pre-configured-action-type-select-type.png[Pre-configured connector create menu]

. In *Create alert*, open the connector dropdown, and then select the preconfigured
connector.
+
The `preconfigured` label distinguishes it from a space-aware connector.
+
[role="screenshot"]
image::images/alert-pre-configured-connectors-dropdown.png[Dropdown list with pre-cofigured connectors]

. Click *Add action*.
8 changes: 4 additions & 4 deletions docs/user/alerting/action-types/slack.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ Webhook URL:: The URL of the incoming webhook. See https://api.slack.com/messa
name: preconfigured-slack-action-type
actionTypeId: .slack
config:
webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz' <1>
webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz'
--

`config` defines the action type specific to the configuration and contains the following properties:

<1> `webhookUrl:` is URL string and correspond to *Webhook URL*.
`config` defines the action type specific to the configuration.
`config` contains
`webhookUrl`, a string that corresponds to *Webhook URL*.


[float]
Expand Down
Loading

0 comments on commit 6316956

Please sign in to comment.