diff --git a/server/pipeline/pipeline-params.mdx b/server/pipeline/pipeline-params.mdx index 07d11e78..f98574c2 100644 --- a/server/pipeline/pipeline-params.mdx +++ b/server/pipeline/pipeline-params.mdx @@ -68,6 +68,10 @@ task = PipelineTask(pipeline, params=params) Period between heartbeats in seconds (when heartbeats are enabled). + + Timeout in seconds before warning about missed heartbeats. + + Whether to enable metrics collection for pipeline performance. @@ -108,7 +112,8 @@ Pipeline heartbeats provide a way to monitor the health of your pipeline by send ```python params = PipelineParams( enable_heartbeats=True, - heartbeats_period_secs=2.0, # Send heartbeats every 2 seconds + heartbeats_period_secs=2.0, # Send heartbeats every 2 seconds + heartbeats_monitor_secs=15.0, # Warn if heartbeat takes more than 15 seconds enable_metrics=True ) ```