Skip to content

Commit 9975e5f

Browse files
committed
add synthetics manage data retention
1 parent 9575321 commit 9975e5f

File tree

1 file changed

+55
-5
lines changed

1 file changed

+55
-5
lines changed

solutions/observability/apps/manage-data-retention.md

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,61 @@ mapped_urls:
44
- https://www.elastic.co/guide/en/serverless/current/observability-synthetics-manage-retention.html
55
---
66

7-
# Manage data retention
7+
# Manage data retention [synthetics-manage-retention]
88

9-
% What needs to be done: Align serverless/stateful
9+
When you set up a synthetic monitor, data from the monitor is saved in [{{es}} data streams](../../../manage-data/data-store/index-types/data-streams.md), an append-only structure in {{es}}.
1010

11-
% Use migrated content from existing pages that map to this page:
11+
There are six data streams recorded by synthetic monitors: `http`, `tcp`, `icmp`, `browser`, `browser.network`, `browser.screenshot`. Elastic will retain data from each data stream for some time period, and the default time period varies by data stream. If you want to reduce the amount of storage required or store data for longer, you can customize how long to retain data for each data stream.
1212

13-
% - [ ] ./raw-migrated-files/observability-docs/observability/synthetics-manage-retention.md
14-
% - [ ] ./raw-migrated-files/docs-content/serverless/observability-synthetics-manage-retention.md
13+
14+
## Synthetics data streams [synthetics-manage-retention-data-streams]
15+
16+
There are six data streams recorded by synthetic monitors:
17+
18+
| Data stream | Data includes | Default retention period | |
19+
| --- | --- | --- | --- |
20+
| `http` | The URL that was checked, the status of the check, and any errors that occurred | 1 year | |
21+
| `tcp` | The URL that was checked, the status of the check, and any errors that occurred | 1 year | |
22+
| `icmp` | The URL that was checked, the status of the check, and any errors that occurred | 1 year | |
23+
| `browser` | The URL that was checked, the status of the check, and any errors that occurred | 1 year | |
24+
| `browser.screenshot` | Binary image data used to construct a screenshot and metadata with information related to de-duplicating this data | 14 days | |
25+
| `browser.network` | Detailed metadata around requests for resources required by the pages being checked | 14 days | |
26+
27+
All types of checks record core metadata. Browser-based checks store two additional types of data: network and screenshot documents. These browser-specific indices are usually many times larger than the core metadata. The relative sizes of each vary depending on the sites being checked with network data usually being the larger of the two by a significant factor.
28+
29+
30+
## Customize data stream lifecycles [synthetics-manage-retention-customize]
31+
32+
If Synthetics browser data streams are storing data longer than necessary, you can opt to retain data for a shorter period.
33+
34+
To find Synthetics data streams:
35+
36+
::::{tab-set}
37+
:group: stack-serverless
38+
39+
:::{tab-item} Elastic Stack v9
40+
:sync: stack
41+
42+
1. Navigate to [{{kib}} index management](../../../manage-data/lifecycle/index-lifecycle-management/index-management-in-kibana.md).
43+
2. Filter the list of data streams for those containing the term `synthetics`.
44+
45+
1. In the UI there will be three types of browser data streams: `synthetics-browser-*`, `synthetics-browser.network-*`, and `synthetics-browser.screenshot-*`.
46+
47+
48+
Then, you can refer to [Tutorial: Customize data retention for integrations](https://www.elastic.co/guide/en/fleet/current/data-streams-ilm-tutorial.html) to learn how to apply a custom {{ilm-init}} policy to the browser data streams.
49+
50+
:::
51+
52+
:::{tab-item} Serverless
53+
:sync: serverless
54+
55+
1. Navigate to **Project settings****Management******Index Management****Data Streams**.
56+
2. Filter the list of data streams for those containing the term `synthetics`.
57+
58+
1. In the UI there will be three types of browser data streams: `synthetics-browser-*`, `synthetics-browser.network-*`, and `synthetics-browser.screenshot-*`.
59+
60+
:::
61+
62+
::::
63+
64+
Then, you can refer to [Tutorial: Customize data retention for integrations](https://www.elastic.co/guide/en/fleet/current/data-streams-ilm-tutorial.html) to learn how to apply a custom {{ilm-init}} policy to the browser data streams.

0 commit comments

Comments
 (0)