From d527b5b11c39e2e5c26233a9734e0ae93605ac92 Mon Sep 17 00:00:00 2001 From: steffen911 Date: Fri, 6 Dec 2024 14:46:41 +0100 Subject: [PATCH] chore: add background migration docs --- pages/self-hosting/background-migrations.mdx | 23 ++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/pages/self-hosting/background-migrations.mdx b/pages/self-hosting/background-migrations.mdx index 844332a7b..0f05edd9b 100644 --- a/pages/self-hosting/background-migrations.mdx +++ b/pages/self-hosting/background-migrations.mdx @@ -3,3 +3,26 @@ description: A guide on Langfuse Background Migrations. --- # Background Migrations + +Langfuse uses background migrations to perform long-running changes within the storage components. +These may include the addition and backfilling of new columns or the migration of data between storages. +Background migrations are executed on startup of the worker container and run in the background until completion or failure. + +## Setup + +Background migrations are enabled by default and can be disabled by setting `LANGFUSE_ENABLE_BACKGROUND_MIGRATIONS=false`. + +## Monitoring + +You can monitor the progress of background migrations within the Langfuse UI. +Click on the Langfuse version tag and select "Background Migrations". +You see all migrations that ever ran and their status. +You can also monitor the progress of background migrations via the worker container logs. + +If migrations are running or have failed, we show a status indicator within the UI to guide users towards the background migrations overview. + +## Deployment stops + +Langfuse does not require deployment stops between minor releases as of now. +However, we recommend that you monitor the progress of background migrations after each update to ensure that all migrations have completed successfully before attempting another update. +We will highlight within the changelog if a deployment stop becomes required.