Skip to content

Commit 97a163c

Browse files
elasticmachineelasticmachine
authored
Merge branch '7.8' into backport/7.8/pr-65467
2 parents b82e961 + 662f24c commit 97a163c

159 files changed

Lines changed: 13585 additions & 12001 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/canvas/canvas-elements.asciidoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ By default, most of the elements you create use demo data until you change the d
3131
[[canvas-add-object]]
3232
==== Add a saved object
3333

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

3636
. Click *Embed object*.
3737

‎docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.error.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) &gt; [error](./kibana-plugin-core-server.savedobjectsmigrationlogger.error.md)
4+
5+
## SavedObjectsMigrationLogger.error property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
error: (msg: string, meta: LogMeta) => void;
11+
```

‎docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ export interface SavedObjectsMigrationLogger
1616
| Property | Type | Description |
1717
| --- | --- | --- |
1818
| [debug](./kibana-plugin-core-server.savedobjectsmigrationlogger.debug.md) | <code>(msg: string) =&gt; void</code> | |
19+
| [error](./kibana-plugin-core-server.savedobjectsmigrationlogger.error.md) | <code>(msg: string, meta: LogMeta) =&gt; void</code> | |
1920
| [info](./kibana-plugin-core-server.savedobjectsmigrationlogger.info.md) | <code>(msg: string) =&gt; void</code> | |
2021
| [warn](./kibana-plugin-core-server.savedobjectsmigrationlogger.warn.md) | <code>(msg: string) =&gt; void</code> | |
2122
| [warning](./kibana-plugin-core-server.savedobjectsmigrationlogger.warning.md) | <code>(msg: string) =&gt; void</code> | |

‎docs/development/plugins/data/server/kibana-plugin-plugins-data-server.iindexpattern.gettimefield.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IIndexPattern](./kibana-plugin-plugins-data-server.iindexpattern.md) &gt; [getTimeField](./kibana-plugin-plugins-data-server.iindexpattern.gettimefield.md)
4+
5+
## IIndexPattern.getTimeField() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
getTimeField?(): IFieldType | undefined;
11+
```
12+
<b>Returns:</b>
13+
14+
`IFieldType | undefined`
15+

‎docs/user/alerting/action-types.asciidoc‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,10 @@ see https://www.elastic.co/subscriptions[the subscription page].
4343
[[create-connectors]]
4444
=== Preconfigured connectors and action types
4545

46-
You can create connectors for actions in <<managing-alerts-and-actions, Alerts and Actions>> or via the action API.
47-
For out-of-the-box and standardized connectors, you can <<pre-configured-connectors, preconfigure connectors>>
46+
For out-of-the-box and standardized connectors, you can <<preconfigured-connector-example, preconfigure connectors>>
4847
before {kib} starts.
4948

50-
Action type with only preconfigured connectors could be specified as a <<pre-configured-action-types, preconfigured action type>>.
49+
If you preconfigure a connector, you can also <<preconfigured-action-type-example, preconfigure its action type>>.
5150

5251
include::action-types/email.asciidoc[]
5352
include::action-types/index.asciidoc[]
@@ -56,4 +55,3 @@ include::action-types/server-log.asciidoc[]
5655
include::action-types/slack.asciidoc[]
5756
include::action-types/webhook.asciidoc[]
5857
include::pre-configured-connectors.asciidoc[]
59-
include::pre-configured-action-types.asciidoc[]

‎docs/user/alerting/action-types/email.asciidoc‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,37 @@ Username:: username for 'login' type authentication.
1919
Password:: password for 'login' type authentication.
2020

2121
[float]
22+
[[Preconfigured-email-configuration]]
23+
==== Preconfigured action type
24+
25+
[source,text]
26+
--
27+
id: 'my-email'
28+
name: preconfigured-email-action-type
29+
actionTypeId: .email
30+
config:
31+
from: testsender@test.com <1.1>
32+
host: validhostname <1.2>
33+
port: 8080 <1.3>
34+
secure: false <1.4>
35+
secrets:
36+
user: testuser <2.1>
37+
password: passwordkeystorevalue <2.2>
38+
--
39+
40+
`config` defines the action type specific to the configuration and contains the following properties:
41+
42+
<1.1> `from:` is an email address and correspond to *Sender*.
43+
<1.2> `host:` is a string and correspond to *Host*.
44+
<1.3> `port:` is a number and correspond to *Port*.
45+
<1.4> `secure:` is a boolean and correspond to *Secure*.
46+
47+
`secrets` defines action type sensitive configuration:
48+
49+
<2.1> `user:` is a string and correspond to *User*.
50+
<2.2> `password:` is a string and correspond to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>.
51+
52+
2253
[[email-action-configuration]]
2354
==== Action configuration
2455

‎docs/user/alerting/action-types/index.asciidoc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,28 @@ Index:: The {es} index to be written to.
1515
Refresh:: Setting for the {ref}/docs-refresh.html[refresh] policy for the write request.
1616
Execution time field:: This field will be automatically set to the time the alert condition was detected.
1717

18+
[float]
19+
[[Preconfigured-index-configuration]]
20+
==== Preconfigured action type
21+
22+
[source,text]
23+
--
24+
id: 'my-index'
25+
name: action-type-index
26+
actionTypeId: .index
27+
config:
28+
index: .kibana <1>
29+
refresh: true <2>
30+
executionTimeField: somedate <3>
31+
--
32+
33+
`config` defines the action type specific to the configuration and contains the following properties:
34+
35+
<1> `index:` is a string and correspond to *Index*.
36+
<2> `refresh:` is a boolean and correspond to *Refresh*.
37+
<3> `executionTimeField:` is a string and correspond to *Execution time field*.
38+
39+
1840
[float]
1941
[[index-action-configuration]]
2042
==== Action configuration

‎docs/user/alerting/action-types/pagerduty.asciidoc‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,29 @@ Name:: The name of the connector. The name is used to identify a connector
135135
API URL:: An optional PagerDuty event URL. Defaults to `https://events.pagerduty.com/v2/enqueue`. If you are using the <<action-settings, `xpack.actions.whitelistedHosts`>> setting, make sure the hostname is whitelisted.
136136
Integration Key:: A 32 character PagerDuty Integration Key for an integration on a service, also referred to as the routing key.
137137

138+
[float]
139+
[[Preconfigured-pagerduty-configuration]]
140+
==== Preconfigured action type
141+
142+
[source,text]
143+
--
144+
id: 'my-pagerduty'
145+
name: preconfigured-pagerduty-action-type
146+
actionTypeId: .pagerduty
147+
config:
148+
apiUrl: https://test.host <1.1>
149+
secrets:
150+
routingKey: testroutingkey <2.1>
151+
--
152+
153+
`config` defines the action type specific to the configuration and contains the following properties:
154+
155+
<1.1> `apiUrl:` is URL string and correspond to *API URL*.
156+
157+
`secrets` defines action type sensitive configuration:
158+
159+
<2.1> `routingKey:` is a string and correspond to *Integration Key*.
160+
138161
[float]
139162
[[pagerduty-action-configuration]]
140163
==== Action configuration

‎docs/user/alerting/action-types/server-log.asciidoc‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,17 @@ Server log connectors have the following configuration properties:
1212

1313
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.
1414

15+
[float]
16+
[[Preconfigured-server-log-configuration]]
17+
==== Preconfigured action type
18+
19+
[source,text]
20+
--
21+
id: 'my-server-log'
22+
name: test
23+
actionTypeId: .server-log
24+
--
25+
1526
[float]
1627
[[server-log-action-configuration]]
1728
==== Action configuration

‎docs/user/alerting/action-types/slack.asciidoc‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,24 @@ Slack connectors have the following configuration properties:
1313
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.
1414
Webhook URL:: The URL of the incoming webhook. See https://api.slack.com/messaging/webhooks#getting_started[Slack Incoming Webhooks] for instructions on generating this URL. If you are using the <<action-settings, `xpack.actions.whitelistedHosts`>> setting, make sure the hostname is whitelisted.
1515

16+
[float]
17+
[[Preconfigured-slack-configuration]]
18+
==== Preconfigured action type
19+
20+
[source,text]
21+
--
22+
id: 'my-slack'
23+
name: preconfigured-slack-action-type
24+
actionTypeId: .slack
25+
config:
26+
webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz' <1>
27+
--
28+
29+
`config` defines the action type specific to the configuration and contains the following properties:
30+
31+
<1> `webhookUrl:` is URL string and correspond to *Webhook URL*.
32+
33+
1634
[float]
1735
[[slack-action-configuration]]
1836
==== Action configuration

0 commit comments

Comments
 (0)