Merge branch 'master' into fix/uptime/await-query-in-usage-collector

elastic · May 12, 2020 · 7142cbe · 7142cbe
2 parents 62450bb + b5f5284
commit 7142cbe
Show file tree

Hide file tree

Showing 109 changed files with 2,945 additions and 700 deletions.
diff --git a/docs/apm/api.asciidoc b/docs/apm/api.asciidoc
@@ -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.
@@ -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"
 }
@@ -124,7 +124,7 @@ PUT /api/apm/settings/agent-configuration
 DELETE /api/apm/settings/agent-configuration
 {
     "service" : {
-        "name" : "frontend",
+        "name": "frontend",
         "environment": "production"
     }
 }
@@ -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,
@@ -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,
@@ -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,
@@ -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,
@@ -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"
     }
 }

diff --git a/docs/canvas/canvas-elements.asciidoc b/docs/canvas/canvas-elements.asciidoc
@@ -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*.
 

diff --git a/docs/user/alerting/action-types.asciidoc b/docs/user/alerting/action-types.asciidoc
@@ -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>>.
@@ -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[]
diff --git a/docs/user/alerting/action-types/email.asciidoc b/docs/user/alerting/action-types/email.asciidoc
@@ -28,27 +28,46 @@ Password::  password for 'login' type authentication.
    name: preconfigured-email-action-type
    actionTypeId: .email
    config:
-     from: [email protected] <1.1>
-     host: validhostname <1.2>
-     port: 8080 <1.3>
-     secure: false <1.4>
+     from: [email protected]
+     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

diff --git a/docs/user/alerting/action-types/index.asciidoc b/docs/user/alerting/action-types/index.asciidoc
@@ -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]

diff --git a/docs/user/alerting/action-types/pagerduty.asciidoc b/docs/user/alerting/action-types/pagerduty.asciidoc
@@ -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]]

diff --git a/...erting/pre-configured-connectors.asciidoc → ...-types/pre-configured-connectors.asciidoc b/...erting/pre-configured-connectors.asciidoc → ...-types/pre-configured-connectors.asciidoc
@@ -1,9 +1,9 @@
 [role="xpack"]
 [[pre-configured-action-types-and-connectors]]
 
-== Preconfigured connectors and action types
+=== Preconfigured connectors and action types
 
-You can preconfigure an action type or a connector to have all the information it needs prior to startup
+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:
@@ -13,15 +13,15 @@ action are predefined, including the connector name and ID.
 - Appear in all spaces because they are not saved objects.
 - Cannot be edited or deleted.
 
-Sensitive configuration information, such as credentials, can use the <<creating-keystore, {kib} keystore>>.
-
-A preconfigured action types has only preconfigured connectors. Preconfigured connectors can belong to either the preconfigured action type or to the regular action type.
+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]]
-=== Creating a preconfigured connector
+==== Preconfigured connectors
 
-The following example shows a valid configuration of two out-of-the box connectors: <<slack-action-type, Slack>> and <<webhook-action-type, Webhook>>.
+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:
@@ -44,7 +44,7 @@ The following example shows a valid configuration of two out-of-the box connecto
         password: changeme
 ```
 
-<1> the key is the action connector identifier, eg `my-slack1` in this example.
+<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.
@@ -55,74 +55,67 @@ The following example shows a valid configuration of two out-of-the box connecto
 Sensitive properties, such as passwords, can also be stored in the <<creating-keystore, {kib} keystore>>.
 ==============================================
 
-[float]
-[[preconfigured-action-type-example]]
-=== Creating a preconfigured action type
-
-In the `kibana.yml` file:
-
-. Exclude the action type from `xpack.actions.enabledActionTypes`.
-. Add all its preconfigured connectors.
-
-The following example shows a valid configuration of 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` should exclude 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.
-
+////
 [float]
 [[managing-pre-configured-connectors]]
-=== Managing preconfigured connectors
+==== View preconfigured connectors
+////
 
-Preconfigured connectors appear in the connector list, regardless of which space the user is in.
-They are tagged as “preconfigured” and cannot be deleted.
+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 on a preconfigured connector shows the description, but not any of the configuration.
+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.
+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]
-[[managing-pre-configured-action-types]]
-=== Managing preconfigured action types
+[[preconfigured-action-type-example]]
+==== Preconfigured action type
 
-Clicking *Create connector* shows the list of available action types.
-Disabled action types are not included.
+This example shows a preconfigured action type with one out-of-the box connector.
 
-[role="screenshot"]
-image::images/pre-configured-action-type-select-type.png[Pre-configured connector create menu]
+```js
+  xpack.actions.enabledActionTypes: ['.slack', '.email', '.index'] <1>
+  xpack.actions.preconfigured:                                     <2>
+    my-server-log:
+      actionTypeId: .server-log
+      name: 'Server log #xyz'
+```
 
-[float]
-[[pre-configured-connector-alert-form]]
-=== Alert with a preconfigured connector
+<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.
 
-When attaching an action to an alert,
-select from a list of available action types, and
-then select the Slack or Webhook type. Those action types were configured previously.
-The preconfigured connector is installed and is automatically selected.
+[[managing-pre-configured-action-types]]
+To attach a preconfigured action to an alert:
 
-[role="screenshot"]
-image::images/alert-pre-configured-slack-connector.png[Create alert with selected Slack action type]
+. In *Management > Alerts and Actions*, open the *Connectors* tab.
 
-The dropdown is populated with additional preconfigured Slack connectors.
-The `preconfigured` label distinguishes them from space-aware connectors that use saved objects.
+. 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*.