Skip to content

docs: update for pipecat PR #4187 #672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
markbackman wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −1
Open

docs: update for pipecat PR #4187 #672

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion server/pipeline/pipeline-params.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ task = PipelineTask(pipeline, params=params)
Period between heartbeats in seconds (when heartbeats are enabled).
</ParamField>

<ParamField path="heartbeats_monitor_secs" type="float" default="10.0">
Timeout in seconds before warning about missed heartbeats.
</ParamField>

<ParamField path="enable_metrics" type="bool" default="False">
Whether to enable metrics collection for pipeline performance.
</ParamField>
Expand Down Expand Up @@ -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
)
```
Expand Down
Loading