Skip to content

Commit 1451e5c

Browse files
authored
Merge branch 'main' into lcawl/gs-search
2 parents fdf4b69 + cf995fb commit 1451e5c

File tree

40 files changed

+594
-1133
lines changed

40 files changed

+594
-1133
lines changed

deploy-manage/cloud-organization/billing/billing-faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ $$$faq-included$$$What is included in my paid {{ech}} deployment?
9999

100100
* Free 1GB RAM {{kib}} instance
101101
* Free 1GB RAM Machine Learning node
102-
* Free 1GB RAM APM server
102+
* Free 1GB RAM APM / Integrations Server instance
103103
* A free allowance for [data transfer and snapshot storage costs](#faq-dts)
104104

105105
Note that if you go above the free tier of Kibana/ML/APM (for example, a 2GB {{kib}} instance), you will be charged in full for the size of that instance.

deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ $$$ec-restrictions-apis-kibana$$$
7272
* {{es}} plugins, are not enabled by default for security purposes. Reach out to support if you would like to enable {{es}} plugins support on your account.
7373
* Some {{es}} plugins do not apply to {{ecloud}}. For example, you won’t ever need to change discovery, as {{ecloud}} handles how nodes discover one another.
7474
% * In {{es}} 5.0 and later, site plugins are no longer supported. This change does not affect the site plugins {{ecloud}} might provide out of the box, such as Kopf or Head, since these site plugins are serviced by our proxies and not {{es}} itself.
75-
% * In {{es}} 5.0 and later, site plugins such as Kopf and Paramedic are no longer provided. We recommend that you use our [cluster performance metrics](../../monitor/stack-monitoring.md), [X-Pack monitoring features](../../monitor/stack-monitoring.md) and Kibana’s (6.3+) [Index Management UI](/manage-data/lifecycle/index-lifecycle-management/index-management-in-kibana.md) if you want more detailed information or perform index management actions.
75+
% * In {{es}} 5.0 and later, site plugins such as Kopf and Paramedic are no longer provided. We recommend that you use our [cluster performance metrics](../../monitor/stack-monitoring.md), [X-Pack monitoring features](../../monitor/stack-monitoring.md) and Kibana’s (6.3+) [Index Management UI](/manage-data/data-store/index-basics.md#manage-indices) if you want more detailed information or perform index management actions.
7676

7777

7878
## Watcher [ec-restrictions-watcher]
@@ -81,7 +81,7 @@ Watcher encryption Key Setup is not supported.
8181

8282
Changing the default throttle period is not possible. You can specify a throttle period per watch, however.
8383

84-
Watcher comes preconfigured with a directly usable email account provided by Elastic. However, this account can’t be reconfigured and is subject to some limitations. For more information on the limits of the Elastic mail server, check the [cloud email service limits](../../../explore-analyze/alerts-cases/watcher/enable-watcher.md#cloud-email-service-limits)
84+
Watcher comes preconfigured with a directly usable email account provided by Elastic. However, this account can’t be reconfigured and is subject to some limitations. For more information on the limits of the Elastic mail server, check the [cloud email service limits](/deploy-manage/deploy/elastic-cloud/tools-apis.md#email-service-limits).
8585

8686
Alternatively, a custom mail server can be configured as described in [Configuring a custom mail server](../../../explore-analyze/alerts-cases/watcher/enable-watcher.md#watcher-custom-mail-server)
8787

deploy-manage/deploy/elastic-cloud/tools-apis.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,3 +104,16 @@ serverless: unavailable
104104

105105
:::{include} /deploy-manage/deploy/_snippets/tpec.md
106106
:::
107+
108+
## Elastic Cloud email service
109+
110+
{{ecloud}} provides a built-in email service used by the preconfigured [email connector](kibana://reference/connectors-kibana/email-action-type.md), available in both {{ech}} deployments and {{serverless-full}} projects. This service can be used to send [alert](/explore-analyze/alerts-cases/alerts.md) notifications and is also supported in {{ech}} by [Watcher](/explore-analyze/alerts-cases/watcher/enable-watcher.md).
111+
112+
### Email service limits
113+
114+
The following quotas apply to both {{ech}} deployments and {{serverless-full}} projects when using the Elastic email service:
115+
116+
* Email sending quota: 500 emails per 15 minute period.
117+
* Maximum number of recipients per message: 30 recipients per email (To, CC, and BCC all count as recipients).
118+
* Maximum message size (including attachments): 10 MB per message (after Base64 encoding).
119+
* The email-sender can't be customized (Any custom `From:` header will be removed).

deploy-manage/tools/snapshot-and-restore/s3-repository.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -380,12 +380,16 @@ There are a number of storage systems that provide an S3-compatible API, and the
380380

381381
By default {{es}} communicates with your storage system using HTTPS, and validates the repository’s certificate chain using the JVM-wide truststore. Ensure that the JVM-wide truststore includes an entry for your repository. If you wish to use unsecured HTTP communication instead of HTTPS, set `s3.client.CLIENT_NAME.protocol` to `http`.
382382

383-
[MinIO](https://minio.io) is an example of a storage system that provides an S3-compatible API. The `s3` repository type allows {{es}} to work with MinIO-backed repositories as well as repositories stored on AWS S3. Other S3-compatible storage systems may also work with {{es}}, but these are not covered by the {{es}} test suite.
384-
385383
There are many systems, including some from very well-known storage vendors, which claim to offer an S3-compatible API despite failing to emulate S3’s behavior in full. If you are using such a system for your snapshots, consider using a [shared filesystem repository](shared-file-system-repository.md) based on a standardized protocol such as NFS to access your storage system instead. The `s3` repository type requires full compatibility with S3. In particular it must support the same set of API endpoints, with the same parameters, return the same errors in case of failures, and offer consistency and performance at least as good as S3 even when accessed concurrently by multiple nodes. You will need to work with the supplier of your storage system to address any incompatibilities you encounter. Don't report {{es}} issues involving storage systems which claim to be S3-compatible unless you can demonstrate that the same issue exists when using a genuine AWS S3 repository.
386384

387385
You can perform some basic checks of the suitability of your storage system using the [repository analysis API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-analyze). If this API does not complete successfully, or indicates poor performance, then your storage system is not fully compatible with AWS S3 and therefore unsuitable for use as a snapshot repository. However, these checks do not guarantee full compatibility.
388386

387+
::::{admonition} Using MinIO with {{es}}
388+
[MinIO](https://minio.io) is an example of a storage system that provides an S3-compatible API. The `s3` repository type allows {{es}} to work with MinIO-backed repositories as well as repositories stored on AWS S3. The {{es}} test suite includes some checks which aim to detect deviations in behavior between MinIO and AWS S3. Elastic will report directly to the MinIO project any deviations in behavior found by these checks. If you are running a version of MinIO whose behavior deviates from that of AWS S3 then you must upgrade your MinIO installation. If in doubt, please contact the MinIO support team for further information.
389+
390+
The performance, reliability, and durability of a MinIO-backed repository depend on the properties of the underlying infrastructure and on the details of your MinIO configuration. You must design your storage infrastructure and configure MinIO in a way that ensures your MinIO-backed repository has performance, reliability, and durability characteristics which match AWS S3 in order for it to be fully S3-compatible. If you need assistance with your MinIO configuration, please contact the MinIO support team.
391+
::::
392+
389393
Most storage systems can be configured to log the details of their interaction with {{es}}. If you are investigating a suspected incompatibility with AWS S3, it is usually simplest to collect these logs and provide them to the supplier of your storage system for further analysis. If the incompatibility is not clear from the logs emitted by the storage system, configure {{es}} to log every request it makes to the S3 API by [setting the logging level](/deploy-manage/monitor/logging-configuration/update-elasticsearch-logging-levels.md) of the `com.amazonaws.request` logger to `DEBUG`.
390394

391395
To prevent leaking sensitive information such as credentials and keys in logs, {{es}} rejects configuring this logger at high verbosity unless [insecure network trace logging](elasticsearch://reference/elasticsearch/configuration-reference/networking-settings.md#http-rest-request-tracer) is enabled. To do so, you must explicitly enable it on each node by setting the system property `es.insecure_network_trace_enabled` to `true`.

deploy-manage/users-roles/cluster-or-deployment-auth/saml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Because this feature is designed with {{kib}} in mind, most sections of this gui
3737

3838
The SAML support in {{kib}} is designed with the expectation that it will be the primary (or sole) authentication method for users of that {{kib}} instance. After you enable SAML authentication in {{kib}}, it will affect all users who try to login. The [Configuring {{kib}}](/deploy-manage/users-roles/cluster-or-deployment-auth/saml.md#saml-configure-kibana) section provides more detail about how this works.
3939

40-
For a detailed walk-through of how to implement SAML authentication for {{kib}} with Microsoft Entra ID as an identity provider, refer to our guide [Set up SAML with Microsoft Entra ID](/deploy-manage/users-roles/cluster-or-deployment-auth/saml.md).
40+
For a detailed walk-through of how to implement SAML authentication for {{kib}} with Microsoft Entra ID as an identity provider, refer to our guide [Set up SAML with Microsoft Entra ID](/deploy-manage/users-roles/cluster-or-deployment-auth/saml-entra.md).
4141

4242
To configure SAML, you need to perform the following steps:
4343

docset.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ subs:
278278
fleet-server-issue: "https://github.com/elastic/fleet-server/issues/"
279279
fleet-server-pull: "https://github.com/elastic/fleet-server/pull/"
280280
kib-pull: "https://github.com/elastic/kibana/pull/"
281-
stack-version: "9.0.0"
281+
stack-version: "9.0.3"
282282
ece_version: "4.0.1"
283283
eck_version: "3.0.0"
284284
eck_release_branch: "3.0"

explore-analyze/alerts-cases/alerts/rule-type-es-query.md

Lines changed: 32 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ When you create an {{es}} query rule, your choice of query type affects the info
2626

2727
1. Define your query
2828

29-
If you use [query DSL](../../query-filter/languages/querydsl.md), you must select an index and time field then provide your query. Only the `query`, `fields`, `_source` and `runtime_mappings` fields are used, other DSL fields are not considered. For example:
29+
* If you use [query DSL](../../query-filter/languages/querydsl.md), you must select an index and time field then provide your query. Only the `query`, `fields`, `_source` and `runtime_mappings` fields are used, other DSL fields are not considered. For example:
3030

3131
```sh
3232
{
@@ -36,34 +36,45 @@ When you create an {{es}} query rule, your choice of query type affects the info
3636
}
3737
```
3838

39-
If you use [KQL](../../query-filter/languages/kql.md) or [Lucene](../../query-filter/languages/lucene-query-syntax.md), you must specify a data view then define a text-based query. For example, `http.request.referrer: "https://example.com"`.
39+
* If you use [KQL](../../query-filter/languages/kql.md) or [Lucene](../../query-filter/languages/lucene-query-syntax.md), you must specify a data view then define a text-based query. For example, `http.request.referrer: "https://example.com"`.
4040

41-
If you use [ES|QL](../../query-filter/languages/esql.md), you must provide a source command followed by an optional series of processing commands, separated by pipe characters (|).
41+
* If you use [ES|QL](../../query-filter/languages/esql.md), you must provide a source command followed by an optional series of processing commands, separated by pipe characters (|).
4242

43-
:::{admonition} Added in 8.16.0
44-
This functionality was added in 8.16.0.
45-
:::
43+
:::{admonition} Added in 8.16.0
44+
This functionality was added in 8.16.0.
45+
:::
4646

47-
For example:
47+
For example:
4848

49-
```sh
50-
FROM kibana_sample_data_logs
51-
| STATS total_bytes = SUM(bytes) BY host
52-
| WHERE total_bytes > 200000
53-
| SORT total_bytes DESC
54-
| LIMIT 10
55-
```
49+
```sh
50+
FROM kibana_sample_data_logs
51+
| STATS total_bytes = SUM(bytes) BY host
52+
| WHERE total_bytes > 200000
53+
| SORT total_bytes DESC
54+
| LIMIT 10
55+
```
56+
57+
2. Specify details for grouping alerts based on your query language.
58+
59+
* If you use query DSL, KQL, or Lucene, set the group and theshold.
60+
61+
When
62+
: Specify how to calculate the value that is compared to the threshold. The value is calculated by aggregating a numeric field within the time window. The aggregation options are: `count`, `average`, `sum`, `min`, and `max`. When using `count` the document count is used and an aggregation field is not necessary.
63+
64+
Over or Grouped Over
65+
: Specify whether the aggregation is applied over all documents or split into groups using up to four grouping fields. If you choose to use grouping, it’s a [terms](elasticsearch://reference/aggregations/search-aggregations-bucket-terms-aggregation.md) or [multi terms aggregation](elasticsearch://reference/aggregations/search-aggregations-bucket-multi-terms-aggregation.md); an alert will be created for each unique set of values when it meets the condition. To limit the number of alerts on high cardinality fields, you must specify the number of groups to check against the threshold. Only the top groups are checked.
5666

57-
2. If you use query DSL, KQL, or Lucene, set the group and theshold.
67+
Threshold
68+
: Defines a threshold value and a comparison operator (`is above`, `is above or equals`, `is below`, `is below or equals`, or `is between`). The value calculated by the aggregation is compared to this threshold.
5869

59-
When
60-
: Specify how to calculate the value that is compared to the threshold. The value is calculated by aggregating a numeric field within the time window. The aggregation options are: `count`, `average`, `sum`, `min`, and `max`. When using `count` the document count is used and an aggregation field is not necessary.
70+
* {applies_to}`stack: ga 9.2` If you use {{esql}}, specify a time field and how to group alerts.
6171

62-
Over or Grouped Over
63-
: Specify whether the aggregation is applied over all documents or split into groups using up to four grouping fields. If you choose to use grouping, it’s a [terms](elasticsearch://reference/aggregations/search-aggregations-bucket-terms-aggregation.md) or [multi terms aggregation](elasticsearch://reference/aggregations/search-aggregations-bucket-multi-terms-aggregation.md); an alert will be created for each unique set of values when it meets the condition. To limit the number of alerts on high cardinality fields, you must specify the number of groups to check against the threshold. Only the top groups are checked.
72+
Time field
73+
: Choose the time field to use when filtering query results by the time window that you later specify for the rule. You can choose any time field that's availble on the index you're querying, for example, the `@timestamp` field.
6474

65-
Threshold
66-
: Defines a threshold value and a comparison operator (`is above`, `is above or equals`, `is below`, `is below or equals`, or `is between`). The value calculated by the aggregation is compared to this threshold.
75+
Alert group
76+
: Select **Create an alert if matches are found** to create a single alert for multiple events matching the {{esql}} query. Select **Create an alert for each row** to create a separate alert for each event that matches the {{esql}} query. Whenever possible, each alert is given a unique ID.
77+
6778

6879
3. Set the time window, which defines how far back to search for documents.
6980
4. If you use query DSL, KQL, or Lucene, set the number of documents to send to the configured actions when the threshold condition is met.

explore-analyze/alerts-cases/watcher/enable-watcher.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,7 @@ For more information on sending alerts by email, check [Email action](../../../e
3737

3838
## Cloud email service limits [cloud-email-service-limits]
3939

40-
The following quotas apply when using the Elastic email service:
41-
42-
* Email sending quota: 500 emails per 15min period
43-
* Maximum number of recipients per message: 30 recipients per email (To, CC and BCC all count as recipients).
44-
* Maximum message size (including attachments): 10 MB per message (after base64 encoding).
45-
* The email-sender can’t be customized (Any custom `From:` header will be removed)
40+
Refer to [Email service limits](/deploy-manage/deploy/elastic-cloud/tools-apis.md#email-service-limits).
4641

4742
## Advanced usage [advanced_usage]
4843

explore-analyze/alerts-cases/watcher/watcher-ui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To use Watcher in {{kib}}, you must have the built-in `kibana_admin` role and ei
3030
To manage roles, go to the **Roles** management page, or use the [role APIs](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-roles). Watches are shared between all users with the same role.
3131

3232
::::{note}
33-
If you are creating a threshold watch, you must also have the `view_index_metadata` index privilege. See [Index management](../../../manage-data/lifecycle/index-lifecycle-management/index-management-in-kibana.md) for detailed information.
33+
If you are creating a threshold watch, you must also have the `view_index_metadata` index privilege. See [Index management](/manage-data/data-store/index-basics.md#index-management) for detailed information.
3434
::::
3535

3636
## Create a threshold alert [watcher-create-threshold-alert]
-28.3 KB
Loading

0 commit comments

Comments
 (0)