Skip to content

Commit edb5f75

Browse files
authored
Merge branch 'main' into leemthompo/esql-explore-analyze-this-starring-robert-deniro
2 parents f73ad10 + f4af7cc commit edb5f75

File tree

13 files changed

+175
-47
lines changed

13 files changed

+175
-47
lines changed

deploy-manage/monitor/autoops.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,7 @@ AutoOps currently monitors only {{es}}, not the entire {{stack}}. Any deployment
5656
In this section, you'll find the following information:
5757

5858
* How to [open AutoOps](/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md) for your deployment.
59-
* The contents of [AutoOps events](/deploy-manage/monitor/autoops/ec-autoops-events.md).
60-
* The [views](/deploy-manage/monitor/autoops/views.md) AutoOps offers to gain insight into facets of your deployment.
61-
* [Notification settings](/deploy-manage/monitor/autoops/ec-autoops-notifications-settings.md) that allow you to specify when and how to be notified.
62-
* [Event settings](/deploy-manage/monitor/autoops/ec-autoops-event-settings.md) that allow you to fine-tune when events are triggered, and a method to [dismiss](/deploy-manage/monitor/autoops/ec-autoops-dismiss-event.md) certain categories of events.
63-
* The [regions](/deploy-manage/monitor/autoops/ec-autoops-regions.md) where AutoOps is available.
64-
* Additional [frequently asked questions](/deploy-manage/monitor/autoops/ec-autoops-faq.md).
59+
* What [events](/deploy-manage/monitor/autoops/ec-autoops-events.md) are and how you can configure [event settings](/deploy-manage/monitor/autoops/ec-autoops-event-settings.md) and [notifications](/deploy-manage/monitor/autoops/ec-autoops-notifications-settings.md).
60+
* Which [views](/deploy-manage/monitor/autoops/views.md) AutoOps offers to gain insight into your deployment.
61+
* [Regions](/deploy-manage/monitor/autoops/ec-autoops-regions.md) where AutoOps is available.
62+
* [Frequently asked questions](/deploy-manage/monitor/autoops/ec-autoops-faq.md) about AutoOps.

deploy-manage/monitor/autoops/ec-autoops-dismiss-event.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,4 @@ products:
1010

1111
# Dismiss Events [ec-autoops-dismiss-event]
1212

13-
Some events that are triggered may not require your attention immediately, or at all. Users with the appropriate permissions can choose to dismiss an event, preventing AutoOps from opening it. This action can be reversed using the Dismiss events report.
14-
15-
:::{image} /deploy-manage/images/cloud-autoops-dismiss-events.png
16-
:alt: Dismiss events
17-
:::
18-
13+
This page has moved. Refer to [Event actions](/deploy-manage/monitor/autoops/ec-autoops-events.md#event-actions) to learn about what you can do with events, including how to dismiss them.

deploy-manage/monitor/autoops/ec-autoops-event-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ products:
1313
AutoOps events are triggered when specific conditions are met and are closed when those conditions are no longer satisfied. An event can be triggered by multiple conditions, and each event comes with a default setting that can be adjusted differently for each connected deployment.
1414

1515
::::{note}
16-
Only **Organization owners** can set up notifications.
16+
Only **Organization owners** can configure these settings.
1717
::::
1818

1919

deploy-manage/monitor/autoops/ec-autoops-events.md

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,63 @@ applies_to:
66
ess: all
77
products:
88
- id: cloud-hosted
9+
navigation_title: Events
910
---
1011

1112
# AutoOps events [ec-autoops-events]
1213

13-
An AutoOps event provides a detailed analysis of a specific issue, including why it was triggered and the steps needed to resolve it.
14+
AutoOps continuously monitors your {{es}} deployments by sampling performance and health metrics at 10-second intervals. This high-frequency data collection allows AutoOps to rapidly detect and diagnose issues so you can get timely notifications and resolve issues faster.
15+
16+
When AutoOps detects an issue, it creates an event. Events provide detailed analyses of detected issues, including why they were triggered and the steps needed to resolve them.
17+
18+
## Event insights
19+
20+
You can view events on the **Deployment** page in the **Open Events** and **Events History** sections.
21+
22+
When you select an event, a flyout appears with insights and context for the detected issue.
1423

1524
:::{image} /deploy-manage/images/cloud-autoops-events.png
1625
:alt: AutoOps events
1726
:::
1827

19-
The following sections provide you with comprehensive insights and context around issues, the reasons why the event was created, as well as the affected nodes and indices with high indexing activity.
28+
The following table describes the sections in this flyout:
2029

2130
| Section | Description |
2231
| --- | --- |
23-
| What was detected | This section describes the reasons for which the event was created, as well as links to drill down into the issue. |
24-
| Recommendations | AutoOps provides a set of recommendations. The sequence of their appearance indicates the suggested order of steps to address the issue. |
25-
| Event duration | The time the event was detected (opened at) and the time AutoOps identified that the issue no longer exists (closed at). The closing of an event does not necessarily indicate that the customer resolved the issue, but rather that AutoOps no longer detects it. |
26-
| Background and impact | Provides background and context as to why an event is important, and the impact it can have on performance and stability. |
27-
| Event timeline chart | This chart visually represents metrics related to an issue. It appears only for events with dynamic metrics. For example, load issues will have this section, while settings-related issues will not. The event timeline chart displays just the last 15 minutes. |
28-
| Event severity | Events are categorized into three levels of severity - high, medium, and low - based on their potential impact on cluster performance and stability: <br><br>- **High**: Events can immediately cause significant usability, performance and stability problems.<br>- **Medium**: Events may lead to severe problems if not addressed.<br>- **Low**: Events have minimal/not urgent impact. |
32+
| What was detected | Describes why the event was created and provides links to drill down into the detected issue. |
33+
| Recommendations | Lists recommendations to address the issue and improve your cluster's overall performance. The recommendations are organized according to the suggested order of execution. |
34+
| Event duration | Shows when the event was opened (when AutoOps detected the issue), and if applicable, when the event was closed (when AutoOps identified that the issue no longer exists). A closed event doesn't necessarily mean that the issue is resolved, just that AutoOps no longer detects it. |
35+
| Background and impact | Provides background and context about why the event is important and its potential impact on cluster performance and stability. |
36+
| Event timeline chart | Visually presents metrics related to the issue in the last 15 minutes. This chart appears only for events with dynamic metrics. For example, load issues will have this section, but settings-related issues will not. |
37+
| Event severity | Categorizes the event into one of three severity levels based on its potential impact on the cluster: <br><br> **High**: Event can immediately cause significant usability, performance, and stability problems.<br> **Medium**: Event may lead to significant problems if not addressed.<br> **Low**: Event has minimal impact and is not urgent. |
38+
39+
## Event actions
2940

41+
In the event flyout, go to the actions menu and select from the following options:
3042

31-
## Event settings [ec-autoops-event-customize]
43+
### Customize [ec-autoops-event-customize]
3244

33-
AutoOps events are set to `open` and `close` based on triggering mechanisms that have default settings for each event type. You can modify the default settings through the Customize option in the event settings. Be cautious while changing these settings, to avoid situations where alerts fail to trigger.
45+
AutoOps events are opened and closed based on triggering mechanisms that have default settings for each event type. Select **Customize** to change these settings. Avoid making changes that will cause alert triggers to fail.
3446

47+
Refer to [](ec-autoops-event-settings.md) for more details.
3548

36-
## Notifications [ec-autoops-notifications]
49+
### Notifications [ec-autoops-notifications]
3750

38-
AutoOps can send notifications to a variety of operation management tools like PagerDuty, Opsgenie, Slack, Teams and custom webhooks. Refer to [Notifications settings](ec-autoops-notifications-settings.md) for more details.
51+
AutoOps can send event notifications to many operation management tools like PagerDuty, Opsgenie, Slack, Teams, custom webhooks, and more. Select **Notifications** to configure these settings.
3952

53+
Refer to [](ec-autoops-notifications-settings.md) for more details.
4054

41-
## Sharing events with others [ec-autoops-event-sharing]
55+
### Dismiss [ec-autoops-dismiss]
4256

43-
You can easily share event information with other users by sending them a direct link to the AutoOps event using the share event link located at the top right of the event window.
57+
Some events may not require your attention immediately, or at all. If you are an Organization owner, you can dismiss an event to remove all events of its kind from your dashboard and prevent AutoOps from opening other similar events. Select **Dismiss** to dismiss an event.
4458

45-
Only users with access to the AutoOps deployment from which the link was copied can view the event details.
59+
This action can be reversed using the **Dismiss events** report.
60+
61+
### Share event link [ec-autoops-event-sharing]
62+
63+
You can share event information with other users by sending them a link to the event in AutoOps. Select **Share event link** to share the event.
64+
65+
:::{note}
66+
Users can only view the event from the shared link if they have access to the AutoOps deployment from which the link was copied.
67+
:::
4668

deploy-manage/monitor/autoops/ec-autoops-notifications-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ products:
1313
AutoOps can notify you of new events opened or closed through various methods and operation management tools. With a customizable mechanism, you can specify which events you want to be notified about, how you wish to receive these notifications, and their frequency.
1414

1515
::::{note}
16-
Only organization owners can configure these settings.
16+
Only **Organization owners** can configure these settings.
1717
::::
1818

1919

deploy-manage/toc.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -661,6 +661,9 @@ toc:
661661
children:
662662
- file: monitor/autoops/ec-autoops-how-to-access.md
663663
- file: monitor/autoops/ec-autoops-events.md
664+
children:
665+
- file: monitor/autoops/ec-autoops-event-settings.md
666+
- file: monitor/autoops/ec-autoops-notifications-settings.md
664667
- file: monitor/autoops/views.md
665668
children:
666669
- file: monitor/autoops/ec-autoops-overview-view.md
@@ -669,9 +672,7 @@ toc:
669672
- file: monitor/autoops/ec-autoops-index-view.md
670673
- file: monitor/autoops/ec-autoops-shards-view.md
671674
- file: monitor/autoops/ec-autoops-template-optimizer.md
672-
- file: monitor/autoops/ec-autoops-notifications-settings.md
673-
- file: monitor/autoops/ec-autoops-event-settings.md
674-
- file: monitor/autoops/ec-autoops-dismiss-event.md
675+
- hidden: monitor/autoops/ec-autoops-dismiss-event.md
675676
- file: monitor/autoops/ec-autoops-regions.md
676677
- file: monitor/autoops/ec-autoops-faq.md
677678
- hidden: monitor/autoops/cc-autoops-as-cloud-connected.md

explore-analyze/machine-learning/nlp/ml-nlp-model-ref.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,7 @@ products:
1515
The minimum dedicated ML node size for deploying and using the {{nlp}} models is 16 GB in {{ech}} if [deployment autoscaling](../../../deploy-manage/autoscaling.md) is turned off. Turning on autoscaling is recommended because it allows your deployment to dynamically adjust resources based on demand. Better performance can be achieved by using more allocations or more threads per allocation, which requires bigger ML nodes. Autoscaling provides bigger nodes when required. If autoscaling is turned off, you must provide suitably sized nodes yourself.
1616
::::
1717

18-
The {{stack-ml-features}} support transformer models that conform to the standard BERT model interface and use the WordPiece tokenization algorithm.
19-
20-
The current list of supported architectures is:
18+
The {{stack-ml-features}} support transformer models with the following architectures:
2119

2220
* BERT
2321
* BART
103 KB
Loading
107 KB
Loading

manage-data/lifecycle/data-stream/tutorial-update-existing-data-stream.md

Lines changed: 90 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,42 @@ products:
1010

1111
# Tutorial: Update existing data stream [tutorial-manage-existing-data-stream]
1212

13-
To update the lifecycle of an existing data stream you do the following actions:
13+
To update the lifecycle of an existing data stream, perform the following actions:
1414

1515
1. [Set a data stream’s lifecycle](#set-lifecycle)
1616
2. [Remove lifecycle for a data stream](#delete-lifecycle)
1717

1818

1919
## Set a data stream’s lifecycle [set-lifecycle]
2020

21-
To add or to change the retention period of your data stream you can use the [PUT lifecycle API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle).
21+
To add or to change the retention period of your data stream you can use the **Index Management** tools in {{kib}} or the {{es}} [lifecycle API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle).
22+
23+
24+
:::::{tab-set}
25+
:group: kibana-api
26+
:::{tab-item} {{kib}}
27+
:sync: kibana
28+
29+
To change the data retention settings for a data stream:
30+
31+
1. Go to **Stack Management > Index Management** and open the **Data Streams** tab.
32+
1. Use the search tool to find the data stream you're looking for.
33+
1. Select the data stream to view its details.
34+
1. In the data stream details pane, select **Manage > Edit data retention** to adjust the settings. You can do any of the following:
35+
36+
- Select how long to retain your data, in days, hours, minutes, or seconds.
37+
- Choose to **Keep data indefinitely**, so that your data will not be deleted. Your data stream is still managed but the data will never be deleted. Managing a time series data stream such as for logs or metrics enables {{es}} to better store your data even if you do not use a retention period.
38+
- Disable **Enable data retention** to turn off data stream lifecycle management for your data stream.
39+
40+
Note that if the data stream is already managed by [{{ilm-init}}](/manage-data/lifecycle/index-lifecycle-management.md), to edit the data retention settings you must edit the associated {{ilm-init}} policy.
41+
42+
43+
:::
44+
45+
:::{tab-item} API
46+
:sync: api
47+
48+
To change the data retention settings for a data stream:
2249

2350
* You can set infinite retention period, meaning that your data should never be deleted. For example:
2451

@@ -27,7 +54,7 @@ To add or to change the retention period of your data stream you can use the [PU
2754
{ } <1>
2855
```
2956

30-
1. An empty payload means that your data stream is still managed but the data will never be deleted. Managing a time series data stream such as logs or metrics enables {{es}} to better store your data even if you do not use a retention period.
57+
1. An empty payload means that your data stream is still managed but the data will never be deleted. Managing a time series data stream such as for logs or metrics enables {{es}} to better store your data even if you do not use a retention period.
3158

3259
* Or you can set the retention period of your choice. For example:
3360

@@ -39,9 +66,32 @@ To add or to change the retention period of your data stream you can use the [PU
3966
```
4067

4168
1. The retention period of this data stream is set to 30 days. This means that {{es}} is allowed to delete data that is older than 30 days at its own discretion.
69+
:::
70+
:::::
71+
72+
The changes in the lifecycle are applied on all backing indices of the data stream.
73+
74+
You can see the effect of the change in {{kib}} or using the {{es}} [explain API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle):
75+
76+
:::::{tab-set}
77+
:group: kibana-api
78+
:::{tab-item} {{kib}}
79+
:sync: kibana
80+
To check the data retention settings for a data stream:
81+
82+
1. Go to **Stack Management > Index Management** and open the **Data Streams** tab.
83+
1. Use the search tool to find the data stream you're looking for.
84+
1. Select the data stream to view its details. The flyout shows the data retention settings for the data stream. Note that if the data stream is currently managed by an [{{ilm-init}} policy](/manage-data/lifecycle/index-lifecycle-management.md), the **Effective data retention** may differ from the retention value that you've set in the data stream, as indicated by the **Data retention**.
85+
86+
:::{image} /manage-data/images/elasticsearch-reference-lifecycle-status.png
87+
:alt: Index lifecycle status page
88+
:width: 500px
89+
:::
4290

91+
:::{tab-item} API
92+
:sync: api
4393

44-
The changes in the lifecycle are applied on all backing indices of the data stream. You can see the effect of the change via the [explain API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle):
94+
To check the data retention settings for a data stream:
4595

4696
```console
4797
GET .ds-my-data-stream-*/_lifecycle/explain
@@ -90,16 +140,48 @@ The response will look like:
90140
9. The time that will be used to determine when it’s safe to delete this index and all its data.
91141
10. The data retention for this index as well is at least 30 days, as it was recently updated.
92142

93-
143+
:::
144+
:::::
94145

95146
## Remove lifecycle for a data stream [delete-lifecycle]
96147

97-
To remove the lifecycle of a data stream you can use the [delete lifecycle API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-lifecycle). As consequence, the maintenance operations that were applied by the lifecycle will no longer be applied to the data stream and all its backing indices. For example:
148+
To remove the lifecycle of a data stream you can use the **Index Management** tools in {{kib}} or the {{es}} [delete lifecycle API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-lifecycle).
149+
150+
151+
:::::{tab-set}
152+
:group: kibana-api
153+
:::{tab-item} {{kib}}
154+
:sync: kibana
155+
156+
To remove a data stream's lifecycle:
157+
158+
1. Go to **Stack Management > Index Management** and open the **Data Streams** tab.
159+
1. Use the search tool to find the data stream you're looking for.
160+
1. Select the data stream to view its details.
161+
1. In the data stream details pane, select **Manage > Edit data retention**.
162+
1. Turn off the **Enable data retention** option and save your changes. The maintenance operations that were applied by the lifecycle will no longer be applied to the data stream and all of its backing indices.
163+
164+
You can confirm your changes by reopening the data stream pane. The **Effective data retention** will show a **Disabled** status.
165+
166+
::::{image} /manage-data/images/elasticsearch-reference-lifecycle-disabled.png
167+
:alt: Index lifecycle status is disabled
168+
:width: 500px
169+
::::
170+
171+
172+
:::
173+
174+
:::{tab-item} API
175+
:sync: api
176+
177+
To remove a data stream's lifecycle:
98178

99179
```console
100180
DELETE _data_stream/my-data-stream/_lifecycle
101181
```
102182

183+
After running the API request, the maintenance operations that were applied by the lifecycle will no longer be applied to the data stream and all of its backing indices.
184+
103185
You can then use the [explain API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle) again to see that the indices are no longer managed.
104186

105187
```console
@@ -125,5 +207,5 @@ GET .ds-my-data-stream-*/_lifecycle/explain
125207
2. Indication that the index is not managed by the data stream lifecycle.
126208
3. The name of another backing index.
127209
4. Indication that the index is not managed by the data stream lifecycle.
128-
129-
210+
:::
211+
:::::

0 commit comments

Comments
 (0)