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.2.tar.gz (4.2 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.2-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: farol_sdk-0.1.2.tar.gz
  • Upload date:
  • Size: 4.2 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.2.tar.gz
Algorithm Hash digest
SHA256 aad576a23e36647c583d87ae09f87e0489665b2aecdce077cf01e33e8d2ebf31
MD5 977149d64d2478a9bc43b19ac439b7cf
BLAKE2b-256 b4dd3ed2c9080a43c8e998bff97fc29697f113f514b512b97435141803c903b5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: farol_sdk-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 4.7 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ff2fca05ac8e891398563eede7e8b4e879e93ee18bcb8bad2f845d33d2f763cf
MD5 439489e702885049070a8d57f10aef78
BLAKE2b-256 0cb3f65c34bb22fa9c15e42640e13581a03c66ffa76371ae19b36e4306f9b23a

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