Skip to content

Commit e9ad5f3

Browse files
committed
Rename Health events to Account events
1 parent 2bce053 commit e9ad5f3

File tree

18 files changed

+61
-62
lines changed

18 files changed

+61
-62
lines changed

blog-cse/2024/12-31.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ This content release:
7676
- Alert Logic
7777
- Google G Suite Alert Center
7878
- Microsoft Defender Advanced Hunting
79-
- Azure Provisioning, Alert, ResourceHealth, and ServiceHealth events
79+
- Azure Provisioning, Alert, ResourceHealth, and Service Account events
8080

8181
Changes are enumerated below.
8282

docs/api/health-events.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
id: health-events
3-
title: Health Events Management APIs
4-
sidebar_label: Health Events
5-
description: Use HTTP endpoints to view your account's health events.
2+
id: account-events
3+
title: Account Events Management APIs
4+
sidebar_label: Account Events
5+
description: Use HTTP endpoints to view your account's account events.
66
---
77

88
import useBaseUrl from '@docusaurus/useBaseUrl';
@@ -11,23 +11,23 @@ import ApiRoles from '../reuse/api-roles.md';
1111

1212
<img src={useBaseUrl('img/icons/company-value/heart-wellness.png')} alt="Thumbnail icon" width="50"/>
1313

14-
The [Health Events](/docs/manage/health-events) Management API allows you to view the health of your Collectors and Sources from HTTP endpoints.
14+
The [Account Events](/docs/manage/account-events) Management API allows you to view the health of your Collectors and Sources from HTTP endpoints.
1515

1616
## Documentation
1717

1818
<ApiIntro/>
1919

2020
| Deployment | Documentation URL |
2121
|:------------|:------------------------------------------------------|
22-
| AU | https://api.au.sumologic.com/docs/#tag/healthEvents |
23-
| CA | https://api.ca.sumologic.com/docs/#tag/healthEvents |
24-
| DE | https://api.de.sumologic.com/docs/#tag/healthEvents |
25-
| EU | https://api.eu.sumologic.com/docs/#tag/healthEvents |
26-
| FED | https://api.fed.sumologic.com/docs/#tag/healthEvents |
27-
| JP | https://api.jp.sumologic.com/docs/#tag/healthEvents |
28-
| KR | https://api.kr.sumologic.com/docs/#tag/healthEvents |
29-
| US1 | https://api.sumologic.com/docs/#tag/healthEvents |
30-
| US2 | https://api.us2.sumologic.com/docs/#tag/healthEvents |
22+
| AU | https://api.au.sumologic.com/docs/#tag/accountEvents |
23+
| CA | https://api.ca.sumologic.com/docs/#tag/accountEvents |
24+
| DE | https://api.de.sumologic.com/docs/#tag/accountEvents |
25+
| EU | https://api.eu.sumologic.com/docs/#tag/accountEvents |
26+
| FED | https://api.fed.sumologic.com/docs/#tag/accountEvents |
27+
| JP | https://api.jp.sumologic.com/docs/#tag/accountEvents |
28+
| KR | https://api.kr.sumologic.com/docs/#tag/accountEvents |
29+
| US1 | https://api.sumologic.com/docs/#tag/accountEvents |
30+
| US2 | https://api.us2.sumologic.com/docs/#tag/accountEvents |
3131

3232

3333
## Required role capabilities

docs/api/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Use the Sumo Logic Application Programming Interfaces (APIs) to interact with ou
9696
</div>
9797
<div className="box smallbox card">
9898
<div className="container">
99-
<a href="/docs/api/health-events"><img src={useBaseUrl('img/icons/company-value/heart-wellness.png')} alt="Thumbnail icon" width="50"/><h4>Health Events</h4></a>
99+
<a href="/docs/api/account-events"><img src={useBaseUrl('img/icons/company-value/heart-wellness.png')} alt="Thumbnail icon" width="50"/><h4>Account Events</h4></a>
100100
</div>
101101
</div>
102102
<div className="box smallbox card">

docs/get-started/sumo-logic-ui-classic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ To manage data in Sumo Logic, do the following:
242242
* **Collection.** [Manage collectors and sources](/docs/send-data/collection).
243243
* **Logs.** Manage [fields](/docs/manage/fields)[field extraction rules](/docs/manage/field-extractions)[partitions](/docs/manage/partitions)[scheduled views](/docs/manage/scheduled-views)[connections](/docs/alerts/webhook-connections), and [data forwarding](/docs/manage/data-forwarding).
244244
* **Metrics.** Manage metrics rules, [logs-to-metrics](../metrics/logs-to-metrics.md), and [metrics transformation rules](../metrics/metrics-transformation-rules.md).
245-
* **Monitoring.** [Monitors](/docs/alerts/monitors)[connections](/docs/alerts/webhook-connections), and [health events](/docs/manage/health-events).
245+
* **Monitoring.** [Monitors](/docs/alerts/monitors)[connections](/docs/alerts/webhook-connections), and [account events](/docs/manage/account-events).
246246

247247
### Admin: Manage accounts, users, and security
248248

docs/get-started/sumo-logic-ui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Use the **Go To...** menu for quick access to settings and features. <img src={u
8989

9090
With the Sumo Logic Administrator role, you can manage your organization's data collection settings, ingest budget, partitions, and more. To access these settings, go to the top nav bar and click the **Configuration** icon.<br/><img src={useBaseUrl('img/get-started/config.png')} alt="config.png" width="300"/>
9191

92-
* **Collection**. [Collection](/docs/send-data/collection/), [OpenTelemetry Collection](/docs/send-data/opentelemetry-collector/), [Source Template](/docs/send-data), [Status](/docs/manage/ingestion-volume/collection-status-page/), [Ingest Budget](/docs/manage/ingestion-volume/ingest-budgets/), [Health Events](/docs/manage/health-events/), [Archive](/docs/manage/data-archiving/archive), [Data Archiving](/docs/manage/data-archiving/).
92+
* **Collection**. [Collection](/docs/send-data/collection/), [OpenTelemetry Collection](/docs/send-data/opentelemetry-collector/), [Source Template](/docs/send-data), [Status](/docs/manage/ingestion-volume/collection-status-page/), [Ingest Budget](/docs/manage/ingestion-volume/ingest-budgets/), [Account Events](/docs/manage/account-events/), [Archive](/docs/manage/data-archiving/archive), [Data Archiving](/docs/manage/data-archiving/).
9393
* **Logs**. [Fields](/docs/manage/fields/), [Field Extraction Rules](/docs/manage/field-extractions/), [Partitions](/docs/manage/partitions/), [Scheduled Views](/docs/manage/scheduled-views/), [Data Forwarding](/docs/manage/data-forwarding/), [Threat Intelligence](/docs/security/threat-intelligence/).
9494
* **Metrics**. [Metrics Rules](/docs/metrics/metric-rules-editor/), [Logs-to-Metrics](/docs/metrics/logs-to-metrics/), [Metrics Transformation Rules](/docs/metrics/metrics-transformation-rules/).
9595
* **Monitoring**. [Connections](/docs/alerts/webhook-connections).

docs/integrations/saas-cloud/sumo-collection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This app includes [built-in monitors](#sumo-collection-monitors). For details on
1818
:::
1919

2020
:::tip
21-
For related info on collector health events, see [this doc](/docs/manage/health-events).
21+
For related info on collector account events, see [this doc](/docs/manage/account-events).
2222
:::
2323

2424
## Log types

docs/manage/health-events.md

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
id: health-events
3-
title: Health Events
2+
id: account-events
3+
title: Account Events
44
description: Monitor the health of your Collectors and Sources.
55
---
66

@@ -11,50 +11,49 @@ description: Monitor the health of your Collectors and Sources.
1111
| CloudFlex | Professional, Enterprise |
1212
| Credits | Trial, Essentials, Enterprise Operations, Enterprise Security, Enterprise Suite |
1313

14-
Health events allow you to keep track of the health of your Collectors, Sources, and Ingest Budgets. You can use them to find and investigate common errors and warnings that are known to cause collection issues. 
14+
System events allow you to keep track of the health of your Collectors, Sources, and Ingest Budgets. You can use them to find and investigate common errors and warnings that are known to cause collection issues. 
1515

1616
This framework includes the following:
1717

18-
* Health event logs indexed in the [System Event Index](/docs/manage/security/audit-indexes/system-event-index).
19-
* A [health events table](#health-events-table) on the Alerts page.
20-
* A health status column on the [Collection page](#collection-page).
18+
* Account event logs indexed in the [Account Event Index](/docs/manage/security/audit-indexes/account-event-index).
19+
* A [account events table](#account-events-table) on the Alerts page.
20+
* A account status column on the [Collection page](#collection-page).
2121

22-
Health events are sent from Installed Collectors on version 19.308-2 and
23-
later.
22+
Account events are sent from Installed Collectors on version 19.308-2 and later.
2423

2524
## Alerts
2625

27-
Alerts for specific health events are easy to create in the Health Events Table. The details pane of an event provides a **Create Scheduled Search** button to automatically generate the required query.
26+
Alerts for specific account events are easy to create in the Account Events Table. The details pane of an event provides a **Create Scheduled Search** button to automatically generate the required query.
2827

29-
## Health events
28+
## Account events
3029

31-
Health events are created when an issue is detected with a Collector or Source. Events are indexed and searchable in a separate partition named **sumologic_system_events** in the [System Event Index](/docs/manage/security/audit-indexes/system-event-index). For details on what information is available in a health event, see the [common parameters](#common-parameters) table.
30+
Account events are created when an issue is detected with a Collector or Source. Events are indexed and searchable in a separate partition named **sumologic_system_events** in the [Account Event Index](/docs/manage/security/audit-indexes/account-event-index). For details on what information is available in a health event, see the [common parameters](#common-parameters) table.
3231

33-
### Health events table
32+
### Account events table
3433

35-
The health events table allows you to easily view and investigate problems getting your data to Sumo.
34+
The account events table allows you to easily view and investigate problems getting your data to Sumo.
3635

37-
On the health events table, you can search, filter, and sort incidents by key aspects like severity, resource name, event name, resource type, and opened since date.
36+
On the account events table, you can search, filter, and sort incidents by key aspects like severity, resource name, event name, resource type, and opened since date.
3837

39-
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). To access the health events table, in the main Sumo Logic menu select **Manage Data > Monitoring > Health Events**.
38+
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). To access the account events table, in the main Sumo Logic menu select **Manage Data > Monitoring > Health Events**.
4039

41-
[**New UI**](/docs/get-started/sumo-logic-ui/). To access the health events table, in the top menu select **Configuration**, and then under **Data Collection** select **Health Events**. You can also click the **Go To...** menu at the top of the screen and select **Health Events**.
40+
[**New UI**](/docs/get-started/sumo-logic-ui/). To access the account events table, in the top menu select **Configuration**, and then under **Data Collection** select **Account Events**. You can also click the **Go To...** menu at the top of the screen and select **Account Events**.
4241

4342

44-
![health events table.png](/img/health-events/health-events-table.png)
43+
![account events table.png](/img/health-events/health-events-table.png)
4544

4645
Click on a row to view the details of a health event.
4746

4847
![health event detail.png](/img/health-events/health-event-detail.png)
4948

50-
Click the **Create Scheduled Search** button on the details pane to get alerts for specific health events. The unique identifier of the resource, such as the Source or Collector, is used in the query. See [Schedule a Search](../alerts/scheduled-searches/schedule-search.md) for details.
49+
Click the **Create Scheduled Search** button on the details pane to get alerts for specific account events. The unique identifier of the resource, such as the Source or Collector, is used in the query. See [Schedule a Search](../alerts/scheduled-searches/schedule-search.md) for details.
5150

5251
Under the **More Actions** menu you can select:
5352

5453
* **Event History** to run a search against the **sumologic_system_events** partition to view all of the related event logs.
5554
* **View Object** to view the Collector or Source in the Collection page related to the event.
5655

57-
### Health events severity
56+
### Account events severity
5857

5958
Events are categorized by two severity levels, warning and error. The severity column has color-coded error and warning events so you can quickly determine the severity of a given issue.
6059

@@ -71,7 +70,7 @@ common parameters in the order that they are found in health event logs.
7170
|:--|:--|:--|
7271
| status | Either `Healthy` or `Unhealthy` based on the event. | String |
7372
| details | The details of the event include the type as `trackerId`, the `name` of the event, and a `description`. | JSON object of Strings |
74-
| eventType | Health events have a value of `Health-Change`. | String |
73+
| eventType | Account events have a value of `Health-Change`. | String |
7574
| severityLevel | Either `Error` or `Warning` based on the event. | String |
7675
| accountId | The unique identifier of the organization. | String |
7776
| eventId | The unique identifier of the event. | String |
@@ -110,22 +109,22 @@ common parameters in the order that they are found in health event logs.
110109
}
111110
```
112111

113-
## Search health events
112+
## Search Account events
114113

115-
To search all health events run a query against the internal partition
114+
To search all account events run a query against the internal partition
116115
named **sumologic_system_events**. For example,
117116

118117
```sql
119118
_index=sumologic_system_events "Health-Change"
120119
```
121120

122121
:::tip
123-
Create a scheduled search to get alerts for specific health events.
122+
Create a scheduled search to get alerts for specific account events.
124123
:::
125124

126125
### Metadata assignment
127126

128-
Creating a query that defines built-in metadata field values in the scope can help improve search performance and limit results to what you're investigating. [Metadata](../search/get-started-with-search/search-basics/built-in-metadata.md) fields are assigned to health event logs as follows:
127+
Creating a query that defines built-in metadata field values in the scope can help improve search performance and limit results to what you're investigating. [Metadata](../search/get-started-with-search/search-basics/built-in-metadata.md) fields are assigned to account event logs as follows:
129128

130129
| **Metadata Field** | **Assignment Description** |
131130
|:--|:--|
@@ -139,9 +138,9 @@ A **Health** column on the Collection page shows color-coded healthy, error, a
139138

140139
The **status** column now shows the status of Sources manually paused by users.
141140

142-
![Collection health column.png](/img/health-events/Collection-health-column.png)
141+
![Collection account column.png](/img/health-events/Collection-health-column.png)
143142

144-
* Hover your mouse over a Collector or Source to view a tooltip that provides the number of health events detected on the Collector or Source.
143+
* Hover your mouse over a Collector or Source to view a tooltip that provides the number of account events detected on the Collector or Source.
145144

146145
![health tooltip.png](/img/health-events/health_tooltip.png)
147146

docs/manage/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This topic describes features and options that give you administration over acco
2323
</div>
2424
<div className="box smallbox card">
2525
<div className="container">
26-
<a href="/docs/manage/health-events"><img src={useBaseUrl('img/icons/business/user-permissions.png')} alt="icon" width="40"/><h4>Health Events</h4></a>
26+
<a href="/docs/manage/account-events"><img src={useBaseUrl('img/icons/business/user-permissions.png')} alt="icon" width="40"/><h4>Account Events</h4></a>
2727
<p>Monitor the health of your Collectors and Sources.</p>
2828
</div>
2929
</div>

docs/manage/ingestion-volume/ingest-budgets/daily-volume.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -257,11 +257,11 @@ Search for only capacity usage logs:
257257
_index=sumologic_audit _sourceName=VOLUME_QUOTA _sourceCategory=account_management "Budget" "last reset"
258258
```
259259

260-
### Health events
260+
### Account events
261261

262-
Health events allow you to keep track of the health of your Collectors, Sources, and Ingest Budgets. You can use them to find and investigate common errors and warnings that are known to cause collection issues. See [Health events](/docs/manage/health-events.md) for details.
262+
Account events allow you to keep track of the health of your Collectors, Sources, and Ingest Budgets. You can use them to find and investigate common errors and warnings that are known to cause collection issues. See [Account events](/docs/manage/account-events.md) for details.
263263

264-
Ingest budgets that have exceeded their capacity are placed in an **Error** health state. The following are two common queries used to investigate the health of ingest budgets.
264+
Ingest budgets that have exceeded their capacity are placed in an **Error** account state. The following are two common queries used to investigate the health of ingest budgets.
265265

266266
A query to search for all ingest budgets that are over capacity.
267267

docs/manage/manage-subscription/fedramp-capabilities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,6 @@ The following table shows the capabilities included with Sumo Logic’s FedRAMP
102102
| Manage Data - Metrics | [Metrics Rules](/docs/metrics/metric-rules-editor/) |![check](/img/reuse/check.png)|![check](/img/reuse/check.png)|
103103
| Manage Data - Metrics | [Metrics transformation rules](/docs/metrics/metrics-transformation-rules/) |![check](/img/reuse/check.png)|![check](/img/reuse/check.png)|
104104
| Manage Data - Monitoring | [Connections](/docs/alerts/webhook-connections/) |![check](/img/reuse/check.png)|![check](/img/reuse/check.png)|
105-
| Manage Data - Monitoring | [Health events](/docs/manage/health-events/) |![check](/img/reuse/check.png)|![check](/img/reuse/check.png)|
105+
| Manage Data - Monitoring | [Account events](/docs/manage/account-events/) |![check](/img/reuse/check.png)|![check](/img/reuse/check.png)|
106106
| Manage Data - Monitoring | [Monitors](/docs/alerts/monitors/) |![check](/img/reuse/check.png)|![check](/img/reuse/check.png)|
107107
| Manage Data - Monitoring | [SLOs](/docs/observability/reliability-management-slo/) |![check](/img/reuse/check.png)|![check](/img/reuse/check.png)|

0 commit comments

Comments
 (0)