Skip to main content

Agent observability for builders

Project description

farol-sdk

Agent observability for builders. Wrap a function with @trace, pass token counts on the run dict, and Farol syncs runs to your dashboard—cost anomalies, alerts, the lot.

usefarol.dev


Install

pip install farol-sdk

Sync to Supabase and email alerts need extras (zero required deps otherwise):

pip install 'farol-sdk[supabase,resend]'

Set environment variables: SUPABASE_URL, SUPABASE_KEY, optionally SUPABASE_SERVICE_KEY for writes + API key resolution; RESEND_API_KEY and ALERT_EMAIL for anomaly emails.


Usage

from farol import trace

@trace("research-agent", farol_key="frl_your_key_here", model="claude-3-5-haiku-latest")
def my_agent(task: str, *, run):
    run["input_tokens"] = 100
    run["output_tokens"] = 50
    return "done"

The wrapped function receives run with steps, token fields, and timing; Farol computes cost from cost_per_1k_tokens (default suits many providers—override as needed).


License

MIT

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

farol_sdk-0.1.7.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

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

farol_sdk-0.1.7-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file farol_sdk-0.1.7.tar.gz.

File metadata

  • Download URL: farol_sdk-0.1.7.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for farol_sdk-0.1.7.tar.gz
Algorithm Hash digest
SHA256 aff4252d8827c6a02b717fb747cc92007b984ea87fe0fa009f5152b8346b2337
MD5 8e6b06aaf2c3c13ee9baace25e6a77b6
BLAKE2b-256 1a2d8dbaee19547e2226bb5d12e41173ed3a0aa1bfe3fe06c751fc413b764339

See more details on using hashes here.

File details

Details for the file farol_sdk-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: farol_sdk-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for farol_sdk-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c49552e02f1e7b42c5c9247306acc013456c1aa280dd35b3a7e977821af5706c
MD5 c3320cad29577a672f47f346ee6da5a5
BLAKE2b-256 f710f8c0def63a00764a79f59f9389a81db83ef451d659fcb333fe671c2c5719

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