Skip to content

Commit 0e4e0d3

Browse files
shainaraskasshainaraskas
committed
fixes
1 parent 9ae8a06 commit 0e4e0d3

33 files changed

+453
-359
lines changed

‎deploy-manage/monitor/autoops.md‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ applies_to:
1010

1111
AutoOps diagnoses issues in Elasticsearch by analyzing hundreds of metrics, providing root-cause analysis and accurate resolution paths. With AutoOps, customers can prevent and resolve issues, cut down administration time, and optimize resource utilization.
1212

13+
AutoOps is currently only available for [{{ech}} deployments](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md).
14+
1315
:::{image} ../../images/cloud-autoops-overview-page.png
1416
:alt: The Overview page
1517
:::
@@ -41,23 +43,22 @@ AutoOps diagnoses issues in Elasticsearch by analyzing hundreds of metrics, prov
4143

4244
## AutoOps retention period [ec_autoops_retention_period]
4345

44-
AutoOps currently has a four-day retention period for all Cloud Hosted customers.
46+
AutoOps currently has a four-day retention period for all {{ech}} customers.
4547

4648

4749
## AutoOps scope [ec_autoops_scope]
4850

49-
AutoOps currently monitors only {{es}}, not the entire {{stack}}. Any deployment information pertains solely to {{es}}. AutoOps supports {{es}} version according to the [supported Elastic Stack versions](https://www.elastic.co/support/eol). There are plans to expand AutoOps monitoring to the entire stack.
50-
51-
52-
53-
54-
55-
56-
57-
58-
59-
51+
AutoOps currently monitors only {{es}}, not the entire {{stack}}. Any deployment information pertains solely to {{es}}. AutoOps supports {{es}} versions according to the [supported {{es}} versions](https://www.elastic.co/support/eol). There are plans to expand AutoOps monitoring to the entire stack.
6052

6153

54+
## Section overview
6255

56+
In this section, you'll find the following information:
6357

58+
* 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).

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ applies_to:
66
ess: all
77
---
88

9-
# Events Settings [ec-autoops-event-settings]
9+
# Event Settings [ec-autoops-event-settings]
1010

1111
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.
1212

1313
::::{note}
14-
Only a user with Cloud Organization Owner role can set up notifications.
14+
Only **Organization owners** can set up notifications.
1515
::::
1616

1717

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

Lines changed: 10 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -8,45 +8,22 @@ applies_to:
88

99
# AutoOps events [ec-autoops-events]
1010

11-
An AutoOps event provides a detailed analysis of a specific issue, including why it was triggered and the steps needed to resolve it. 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.
11+
An AutoOps event provides a detailed analysis of a specific issue, including why it was triggered and the steps needed to resolve it.
1212

1313
:::{image} ../../../images/cloud-autoops-events.png
1414
:alt: AutoOps events
1515
:::
1616

17+
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.
1718

18-
## What was detected [ec-autoops-what-was-detected]
19-
20-
This section describes the reasons for which the event was created, as well as links to drill down into the issue.
21-
22-
23-
## Recommendations [ec-autoops-recommendations]
24-
25-
AutoOps provides a set of recommendations. The sequence of their appearance indicates the suggested order of steps to address the issue.
26-
27-
28-
## Event duration [ec-autoops-event-duration]
29-
30-
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.
31-
32-
33-
## Background and impact [ec-autoops-background-impact]
34-
35-
Provides background and context as to why an event is important, and the impact it can have on performance and stability.
36-
37-
38-
## Event timeline chart [ec-autoops-event-timeline]
39-
40-
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.
41-
42-
43-
## Event severity [ec-autoops-event-severity]
44-
45-
Events are categorized into three levels of severity - high, medium, and low - based on their potential impact on cluster performance and stability:
46-
47-
* **High**: Events can immediately cause significant usability, performance and stability problems.
48-
* **Medium**: Events may lead to severe problems if not addressed.
49-
* **Low**: Events have minimal/not urgent impact.
19+
| Section | Description |
20+
| --- | --- |
21+
| What was detected | This section describes the reasons for which the event was created, as well as links to drill down into the issue. |
22+
| Recommendations | AutoOps provides a set of recommendations. The sequence of their appearance indicates the suggested order of steps to address the issue. |
23+
| 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. |
24+
| Background and impact | Provides background and context as to why an event is important, and the impact it can have on performance and stability. |
25+
| 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. |
26+
| 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. |
5027

5128

5229
## Event settings [ec-autoops-event-customize]

‎deploy-manage/monitor/autoops/ec-autoops-how-to-access.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ applies_to:
99
# How to access AutoOps [ec-autoops-how-to-access]
1010

1111
::::{note}
12-
AutoOps supports {{es}} version according to the [supported Elastic Stack versions](https://www.elastic.co/support/eol).
12+
AutoOps supports {{es}} versions according to the [supported Elastic Stack versions](https://www.elastic.co/support/eol).
1313
::::
1414

1515

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

Lines changed: 52 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ applies_to:
66
ess: all
77
---
88

9-
# Notifications settings [ec-autoops-notifications-settings]
9+
# Notifications Settings [ec-autoops-notifications-settings]
1010

1111
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.
1212

@@ -60,18 +60,22 @@ The following connectors are available with AutoOps:
6060
* [Microsoft Teams Configuration](#ec-autoops-ms-configuration)
6161
* [Webhook](#ec-autoops-webhook)
6262

63-
### Email [email]
63+
:::{dropdown} Email
64+
$$$email$$$
6465

6566
To set up notifications via email, follow these steps:
6667

6768
1. Add a new **Email** connector.
6869
2. Add a list of emails.
6970
You can add up to 40 emails for a single email connector, and opt in to get alerts also when events close.
70-
4. To receive notifications, scroll down the **Notification** page and click **Add**.
71-
5. Fill in the filter details.
72-
6. Select the events that you want to send to this connector.
71+
3. To receive notifications, scroll down the **Notification** page and click **Add**.
72+
4. Fill in the filter details.
73+
5. Select the events that you want to send to this connector.
74+
:::
7375

74-
### PagerDuty [ec-autoops-pagerduty]
76+
:::{dropdown} PagerDuty
77+
78+
$$$ec-autoops-pagerduty$$$
7579

7680
The PagerDuty integration consists of the following parts:
7781

@@ -86,9 +90,12 @@ The PagerDuty integration consists of the following parts:
8690
2. To receive Slack notifications, add a notification filter. Scroll down the Notification page and click **Add**.
8791
3. Fill in the filter details.
8892
4. Select the events that should be sent to this output.
93+
:::
8994

9095

91-
### Slack [ec-autoops-slack]
96+
:::{dropdown} Slack
97+
98+
$$$ec-autoops-slack
9299

93100
To set up a webhook to send AutoOps notifications to a Slack channel, go through the following steps.
94101

@@ -103,8 +110,12 @@ To set up a webhook to send AutoOps notifications to a Slack channel, go through
103110
9. Copy the webhook URL to set up the webhook notification endpoint in AutoOps.
104111
10. Add the webhook URL when creating the endpoint.
105112

113+
:::
114+
115+
116+
:::{dropdown} VictorOps
106117

107-
### VictorOps [ec-autoops-victorops]
118+
$$$ec-autoops-victorops$$$
108119

109120
The VictorOps integration consists of the following parts:
110121

@@ -119,9 +130,12 @@ The VictorOps integration consists of the following parts:
119130
2. To receive Slack notifications, add a notification filter. Scroll down the Notification page and click Add.
120131
3. Fill in the filter details.
121132
4. Select the events that should be sent to this output.
133+
:::
134+
122135

136+
:::{dropdown} Opsgenie
123137

124-
### Opsgenie [ec-autoops-opsgenie]
138+
$$$ec-autoops-opsgenie$$$
125139

126140
The Opsgenie integration consists of the following parts:
127141

@@ -141,9 +155,11 @@ The Opsgenie integration consists of the following parts:
141155
4. To receive notifications on Opsgenie, you need to add a notification filter. Scroll down the **Notification** page and click **Add**.
142156
5. Fill in the filter details.
143157
6. Select events that should be sent to this output.
158+
:::
144159

160+
:::{dropdown} Microsoft Teams
145161

146-
### Microsoft Teams Configuration [ec-autoops-ms-configuration]
162+
$$$ec-autoops-ms-configuration$$$
147163

148164
To create an incoming webhook on your Microsoft Teams, follow [these instructions](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook).
149165

@@ -155,43 +171,47 @@ Save the URL displayed during the creation of the incoming webhook, as you will
155171
2. To receive notifications into Microsoft Teams, you need to add a notification filter. Scroll down the Notification page and click Add.
156172
3. Fill in the filter details.
157173
4. Select events that should be sent to this output.
174+
:::
158175

159176

160-
### Webhook [ec-autoops-webhook]
177+
::::{dropdown} Webhook
178+
179+
$$$ec-autoops-webhook$$$
161180

162181
A webhook enables an application to provide other applications with real-time information. A webhook is a user-defined HTTP callback (HTTP POST), which is triggered by specific events.
163182

164183
**How to add a webhook notification**
165184

166185
1. Go to **Settings** → **Notifications*** → ***Endpoint settings** and click **Add**.
167-
2. Select Webhook from the drop-dowon list and enter the following details:
186+
2. Select Webhook from the drop-down list and enter the following details:
168187

169-
* Name: It must be a unique name for this webhook.
170-
* URL: This is the endpoint to which HTTP POST requests will be sent when events occur.
171-
* Method: POST
172-
* Header: Content-Type, application/Json
188+
* **Name**: It must be a unique name for this webhook.
189+
* **URL**: This is the endpoint to which HTTP POST requests will be sent when events occur.
190+
* **Method**: POST
191+
* **Header**: Content-Type, application/Json
173192

174193
3. Review and update the message as it appears in the body section. AutoOps provides a set of optional fields to use in the message. Read your application documentation for the expected message schema.
175194

176-
* RESOURCE_ID – Customer Deployment ID
177-
* RESOURCE_NAME – Customer Deployment name
178-
* TITLE – The title of the event.
179-
* DESCRIPTION – The description of the issue that was found.
180-
* SEVERITY – One of the 3 severity levels (High, Medium and Low).
181-
* STATUS – Indicate if the event is currently open or close.
182-
* MESSAGE – The background and impact of the issue
183-
* START_TIME – The time the event was open.
184-
* END_TIME – The time the event was closed.
185-
* ENDPOINT_TYPE – The type of the endpoint (Slack, PagerDuty, Webhook, Opsgenie, VictorOps and MS Teams).
186-
* AFFECTED_NODES – List of node names.
187-
* AFFECTED_INDICES – List of indices names.
188-
* EVENT_LINK – Direct link to the event in AutoOps.
189-
190-
4. Click Validate to check your settings and click **Save**.
195+
* `RESOURCE_ID`: Customer Deployment ID
196+
* `RESOURCE_NAME`: Customer Deployment name
197+
* `TITLE`: The title of the event.
198+
* `DESCRIPTION`: The description of the issue that was found.
199+
* `SEVERITY`: One of the 3 severity levels (High, Medium and Low).
200+
* `STATUS`: Indicate if the event is currently open or close.
201+
* `MESSAGE`: The background and impact of the issue
202+
* `START_TIME`: The time the event was open.
203+
* `END_TIME`: The time the event was closed.
204+
* `ENDPOINT_TYPE`: The type of the endpoint (Slack, PagerDuty, Webhook, Opsgenie, VictorOps and MS Teams).
205+
* `AFFECTED_NODES`: List of node names.
206+
* `AFFECTED_INDICES`: List of indices names.
207+
* `EVENT_LINK`: Direct link to the event in AutoOps.
208+
209+
4. Click **Validate** to check your settings, and then click **Save**.
191210
5. Optionally, you can test the webhook integration by using the [webhook.site](https://webhook.site/#!/view/fe9d630e-2f01-44b7-9e41-ef9520fbe9a7).
192211

193-
::::{note}
212+
:::{note}
194213
When the Endpoint settings have been completed, continue to set up the notification filter to define which events you’d like to be notified about.
214+
:::
195215
::::
196216

197217
## Notifications report [ec-notification-report]

‎deploy-manage/monitor/autoops/views.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
applies_to:
3+
deployment:
4+
ess: all
5+
navigation_title: Views
6+
---
7+
8+
# AutoOps views
9+
10+
AutoOps offers the following views to gain further insight into difference facets of your deployment:
11+
12+
* [](/deploy-manage/monitor/autoops/ec-autoops-overview-view.md)
13+
* [](/deploy-manage/monitor/autoops/ec-autoops-deployment-view.md)
14+
* [](/deploy-manage/monitor/autoops/ec-autoops-nodes-view.md)
15+
* [](/deploy-manage/monitor/autoops/ec-autoops-index-view.md)
16+
* [](/deploy-manage/monitor/autoops/ec-autoops-shards-view.md)
17+
* [](/deploy-manage/monitor/autoops/ec-autoops-template-optimizer.md)

‎deploy-manage/monitor/logging-configuration.md‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,43 @@ applies_to:
1212

1313
% GitHub issue: https://github.com/elastic/docs-projects/issues/350
1414

15-
⚠️ **This page is a work in progress.** ⚠️
15+
⚠️ **This page is a work in progress.** ⚠️
16+
17+
18+
## Logging features [ECE/ECH] [extra-logging-features]
19+
20+
When shipping logs to a monitoring deployment there are more logging features available to you. These features include:
21+
22+
23+
### For {{es}} [extra-logging-features-elasticsearch]
24+
25+
* [Audit logging](../logging-configuration/enabling-audit-logs.md) - logs security-related events on your deployment
26+
* [Slow query and index logging](elasticsearch://reference/elasticsearch/index-settings/slow-log.md) - helps find and debug slow queries and indexing
27+
* Verbose logging - helps debug stack issues by increasing component logs
28+
29+
After you’ve enabled log delivery on your deployment, you can [add the Elasticsearch user settings](../../deploy/cloud-enterprise/edit-stack-settings.md) to enable these features.
30+
31+
32+
### For {{kib}} [extra-logging-features-kibana]
33+
34+
* [Audit logging](../logging-configuration/enabling-audit-logs.md) - logs security-related events on your deployment
35+
36+
After you’ve enabled log delivery on your deployment, you can [add the {{kib}} user settings](../../deploy/cloud-enterprise/edit-stack-settings.md) to enable this feature.
37+
38+
39+
### Other components [extra-logging-features-enterprise-search]
40+
41+
Enabling log collection also supports collecting and indexing the following types of logs from other components in your deployments:
42+
43+
**APM**
44+
45+
* `apm*.log*`
46+
47+
**Fleet and Elastic Agent**
48+
49+
* `fleet-server-json.log-*`
50+
* `elastic-agent-json.log-*`
51+
52+
The `*` indicates that we also index the archived files of each type of log.
53+
54+
Check the respective product documentation for more information about the logging capabilities of each product.

‎deploy-manage/monitor/logging-configuration/update-elasticsearch-logging-levels.md‎

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,12 @@ You can use {{es}}'s application logs to monitor your cluster and diagnose issue
1919
On [Docker](../../deploy/self-managed/install-elasticsearch-with-docker.md), log messages go to the console and are handled by the configured Docker logging driver. To access logs, run `docker logs`.
2020
::::::
2121

22-
::::::{tab-item} Debian (APT)
23-
For [Debian installations](../../deploy/self-managed/install-elasticsearch-with-debian-package.md), {{es}} writes logs to `/var/log/elasticsearch`.
22+
::::::{tab-item} Debian (APT) and RPM
23+
For [Debian](../../deploy/self-managed/install-elasticsearch-with-debian-package.md) and [RPM](../../deploy/self-managed/install-elasticsearch-with-rpm.md) installations, {{es}} writes logs to `/var/log/elasticsearch`.
2424
::::::
2525

26-
::::::{tab-item} RPM
27-
For [RPM installations](../../deploy/self-managed/install-elasticsearch-with-rpm.md), {{es}} writes logs to `/var/log/elasticsearch`.
28-
::::::
29-
30-
::::::{tab-item} macOS
31-
For [macOS `.tar.gz`](../../deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md) installations, {{es}} writes logs to `$ES_HOME/logs`.
32-
33-
Files in `$ES_HOME` risk deletion during an upgrade. In production, we strongly recommend you set `path.logs` to a location outside of `$ES_HOME`. See [Path settings](../../deploy/self-managed/important-settings-configuration.md#path-settings).
34-
::::::
35-
36-
::::::{tab-item} Linux
37-
For [Linux `.tar.gz`](../../deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md) installations, {{es}} writes logs to `$ES_HOME/logs`.
26+
::::::{tab-item} macOS and Linux
27+
For [macOS and Linux `.tar.gz`](../../deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md) installations, {{es}} writes logs to `$ES_HOME/logs`.
3828

3929
Files in `$ES_HOME` risk deletion during an upgrade. In production, we strongly recommend you set `path.logs` to a location outside of `$ES_HOME`. See [Path settings](../../deploy/self-managed/important-settings-configuration.md#path-settings).
4030
::::::

0 commit comments

Comments
 (0)