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.5.tar.gz (4.5 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.5-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: farol_sdk-0.1.5.tar.gz
  • Upload date:
  • Size: 4.5 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.5.tar.gz
Algorithm Hash digest
SHA256 3becb516d94a28a1e19c6d699c168e1db3a2438389c36b4d9da5d18f193a670e
MD5 c62e5ee92575fa0c0c2c60feda5fe345
BLAKE2b-256 9b0b7d1fb681bec6bdc7018498dbb4cade5c1c9262180ff631a6698efa4565cb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: farol_sdk-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 4.9 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 42cf89fd2be1c385ade6f647cf323f7758cc2573c0df4f4d888e216c3e3c4abd
MD5 7330acf562eff88ec34ae939bffda178
BLAKE2b-256 92a1602b2d140a29ffa001fcbad40002403e27dc8d2cd3e30ef681a126368e0f

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