mathdatech/Compose-Examples
1
0
Fork 0
mirror of https://github.com/Haxxnet/Compose-Examples synced 2024-11-27 14:01:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
add notes regarding retention time
This commit is contained in:
LRVT 2024-02-24 23:06:15 +01:00 committed by GitHub
parent dc2c351425
commit 40c8a27b1f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
examples/plausible/README.md
View File

@ -15,3 +15,30 @@ mv clickhouse-user-config.xml /mnt/docker-volumes/plausible/clickhouse/.
docker compose up
````
## Retention Time
Plausible's Clickhouse event database will grow over time. There is no retention time currently implemented or defined. See https://github.com/plausible/analytics/discussions/1354.
However, it is possible to manually define a `TTL`, which will automatically prune event data that hit a specific age. You can do so by running the following commands. Note that these example commands will set the retention time to 356 days. So event or session data, older than 365 days (1 year), will automatically pruned from the database.
> [!WARNING]
> By running the below commands you will configure a retention time. This can cause data loss and impact the statistics shown in the Plausible dashboard. Please run wisely and choose your preferred retention time. The example uses 365 days, so you can inspect website statistics back to 1 year.
````
# exec into the running docker container
docker compose exec plausible_events_db clickhouse-client
# select the correct database
\c plausible_events_db
# alter events_v2 table and add TTL with retention time
ALTER TABLE events_v2 MODIFY TTL timestamp + INTERVAL 365 DAY;
# alter sessions_v2 table and add TTL with retention time
ALTER TABLE sessions_v2 MODIFY TTL timestamp + INTERVAL 365 DAY;
# optimization
OPTIMIZE TABLE events_v2 FINAL;
OPTIMIZE TABLE sessions_v2 FINAL;
````