Skip to content

Commit edc2b35

Browse files
kirkrodriguesquinntaylormitchellhaiqi96
authored
Apply suggestions from code review
Co-authored-by: Quinn Taylor Mitchell <[email protected]> Co-authored-by: haiqi96 <[email protected]>
1 parent 9654d87 commit edc2b35

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/src/user-guide/guides-retention.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ retention period. This guide explains:
99

1010
## How retention works
1111

12-
To support retention periods, CLP (specifically, the garbage collector component) periodically scans
13-
for and deletes expired data (archives or search results). To understand the high-level algorithm,
14-
first consider the following definitions:
12+
To support retention periods, CLP's garbage collector component periodically scans for and deletes
13+
expired data (archives or search results). To understand the high-level algorithm, first consider
14+
the following definitions:
1515

1616
| Term | Description |
1717
|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -30,7 +30,7 @@ $$data\_timestamp < current\_time - retention\_period$$
3030

3131
+++
3232
**Figure 1**: The criteria for determining whether a piece of data has expired and should be
33-
deleted (i.e., the data's expiry criteria).
33+
deleted.
3434
:::
3535

3636
For example, if...
@@ -95,8 +95,8 @@ deleted the next time the garbage collector runs.
9595

9696
If your log events use timestamps that **aren't** in the UTC time zone, you will need to adjust the
9797
configured retention period to ensure expired archives are deleted at the correct time. This is
98-
because CLP currently doesn't support parsing time zone information from timestamps that have it,
99-
whereas the garbage collector runs based on the UTC time zone.
98+
because CLP currently doesn't support parsing time zone information, and the garbage collector runs
99+
based on the UTC time zone.
100100

101101
For example, let's say:
102102

@@ -192,7 +192,7 @@ still be in use by active jobs. To do so, CLP employs the following mechanisms:
192192

193193
:::{warning}
194194
A hanging search job will prevent CLP from deleting expired archives. Restarting the query scheduler
195-
will mark such jobs as failed and allow garbage collection to resume.
195+
will mark such jobs as killed and allow garbage collection to resume.
196196
:::
197197

198198
### Fault tolerance

0 commit comments

Comments
 (0)