docs: add data lifecycly policy

openedx · Apr 22, 2024 · f8402fc · f8402fc
1 parent eb2d3bc
commit f8402fc
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/docs/concepts/data_lifecycle_policy.rst b/docs/concepts/data_lifecycle_policy.rst
@@ -0,0 +1,12 @@
+.. _data-lifecycle-policy:
+
+Data Lifecycle Policy
+*********************
+
+What it is
+##########
+
+Aspects is a data pipeline that captures, transforms, and aggregates tracking logs from the Open edX platform into xAPI statements and stores them in a ClickHouse database.
+However, the data is not stored indefinitely by default. The data is keep for 1 year by default, but this can be adjusted by the site operator via the setting `ASPECTS_DATA_TTL_EXPRESSION` in the tutor plugin.
+
+The setting value is a ClickHouse expression that defines the TTL policy for the data. The expression is evaluated for each row in the table and should return a date. Rows with a date in the past are deleted. You can read more about the TTL policy in the ClickHouse documentation: https://clickhouse.tech/docs/en/engines/table-engines/mergetree-family/mergetree/#ttl
diff --git a/docs/concepts/index.rst b/docs/concepts/index.rst
@@ -9,6 +9,7 @@ Concepts
    xAPI <xapi_concepts>
    Tracking Logs <tracking_logs>
    Clickhouse <clickhouse>
+   Data Lifecycle Policy <data_lifecycle_policy>
    dbt <dbt>
    Ralph <ralph>
    Vector <vector>