Skip to main content

Voice AI observability dev tool for Pipecat

Project description

Finchvox - elevated debugging for Pipecat Voice AI

Do your eyes bleed like a Vecna victim watching Pipecat logs fly by? Does flipping between audio recordings, transcripts, and logs damage your ⌘+tab keys from frequent use? If so, meet Finchvox, a local debugger purpose-built for Voice AI apps.

Finchvox unifies conversation audio, logs, traces, and metrics in a single UI, highlighting voice-specific problems like interruptions and high user <-> bot latency.

👇 Click the image for a short video:

Table of Contents

Prerequisites

  • Python 3.10 or higher
  • A Pipecat Voice AI application

Installation

# uv
uv add finchvox "pipecat-ai[tracing]"

# Or with pip
pip install finchvox "pipecat-ai[tracing]"

Setup

  1. Add the following to the top of your bot (e.g., bot.py):
import finchvox
from finchvox import FinchvoxProcessor

finchvox.init(service_name="my-voice-app")
  1. Add FinchvoxProcessor to your pipeline, ensuring it comes after transport.output():
pipeline = Pipeline([
    # SST, LLM, TTS, etc. processors
    transport.output(),
    FinchvoxProcessor(), # Must come after transport.output()
    context_aggregator.assistant(),
])
  1. Initialize your PipelineTask with metrics, tracing and turn tracking enabled:
task = PipelineTask(
    pipeline,
    params=PipelineParams(enable_metrics=True),
    enable_tracing=True,
    enable_turn_tracking=True,
)

Configuration

The finchvox.init() function accepts the following optional parameters:

Parameter Default Description
endpoint "http://localhost:4317" Finchvox collector endpoint
insecure True Use insecure gRPC connection (no TLS)
capture_logs True Send logs to collector alongside traces
log_modules None Additional module prefixes to capture (e.g., ["myapp"])

By default, logs from pipecat.*, finchvox.*, __main__, and any source files in your project directory are captured. Use log_modules to include additional third-party modules.

Usage - Finchvox server

uv run finchvox start

For the list of available options, run:

uv run finchvox --help

Troubleshooting

No spans being written

  1. Check collector is running: Look for "OTLP collector listening on port 4317" log message
  2. Verify client endpoint: Ensure Pipecat is configured to send to http://localhost:4317

Telemetry

FinchVox collects minimal, anonymous usage telemetry to help improve the project. No personal data, IP addresses, or session content is collected.

What's collected:

  • Event type (server_start, session_ingest, session_view)
  • FinchVox version
  • Operating system (macOS, Linux, or Windows)
  • Timestamp

Disable telemetry:

finchvox start --telemetry false

Or set the environment variable:

export FINCHVOX_TELEMETRY=false

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

finchvox-0.0.8.tar.gz (48.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

finchvox-0.0.8-py3-none-any.whl (202.5 kB view details)

Uploaded Python 3

File details

Details for the file finchvox-0.0.8.tar.gz.

File metadata

  • Download URL: finchvox-0.0.8.tar.gz
  • Upload date:
  • Size: 48.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for finchvox-0.0.8.tar.gz
Algorithm Hash digest
SHA256 972010c1d271014649fec19904c1fe8e4cc71e6d7278ec501b30ab4b0dc4428f
MD5 f2f0ba3809e7d81b4f7a646cb56ea15f
BLAKE2b-256 e2ecb497b7c087ef7530ce5214945b86fae8450a6845cd5a582a76779cb37640

See more details on using hashes here.

File details

Details for the file finchvox-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: finchvox-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 202.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for finchvox-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 8e82424ee720426bcfa5f758e7c411abf231e8699f3dd4bfd75b215f2da7ba5c
MD5 30b449049aaace0949867e262d13234c
BLAKE2b-256 0d97ba91d19e37acc8fb4bf055663ea220e7ecd860d613e8c289f343313fbdfa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page