Doc: Explain how lifetime of logging links is configured (#5503)

Signed-off-by: Fabio Grätz <[email protected]> Signed-off-by: Fabio M. Graetz, Ph.D. <[email protected]> Co-authored-by: Fabio Grätz <[email protected]> Co-authored-by: Nikki Everett <[email protected]>
flyteorg · Jun 25, 2024 · f715341 · f715341
1 parent 3ee7120
commit f715341
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/docs/user_guide/productionizing/configuring_logging_links_in_the_ui.md b/docs/user_guide/productionizing/configuring_logging_links_in_the_ui.md
@@ -86,6 +86,22 @@ Flytepropeller pod would be created as:
 This code snippet will output two logs per task that use the log plugin.
 However, not all task types use the log plugin; for example, the Snowflake plugin will use a link to the Snowflake console.
 
+### Configure lifetime of logging links
+
+By default, log links are shown once a task starts running and do not disappear when the task finishes. Certain log links might, however, be helpful when a task is still queued or initializing, for instance, to debug why a task might not be able to start. Other log links might not be valid anymore once the task terminates. You can configure the lifetime of log links in the following way:
+
+```yaml
+task_logs:
+  plugins:
+    logs:
+      templates:
+        - displayName: <name-to-show>
+          hideOnceFinished: true
+          showWhilePending: true
+          templateUris:
+            - "https://..."
+```
+
 ## Datadog integration
 
 To send your Flyte workflow logs to Datadog, you can follow these steps: