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.3.tar.gz (4.3 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.3-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for farol_sdk-0.1.3.tar.gz
Algorithm Hash digest
SHA256 8fb102e217b60d3fd54fda7f68cc2ced1d2baecc8eed5dc84c1f0cbca154c19d
MD5 eb5c24d12b672a7e68f32e18599c2250
BLAKE2b-256 46f5fedb1adce2bf074f04eb856ffd83b2d3f54f994e42bcaa5c96f70921934b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for farol_sdk-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ddec3246359bae890d8679f72f6811868f716a2fc50501a5a943581ade16ac21
MD5 a5829caf975997d6039197036f6454c8
BLAKE2b-256 da5aaa2051fe4bd8816a6993bd1e4143fd4323be4a145235af7dd6578c6f554b

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