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.6.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.6-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: farol_sdk-0.1.6.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.6.tar.gz
Algorithm Hash digest
SHA256 e2392a1f7ab8146f18b52a7995d26bb92cccf902a8e39c7d698a07f85dd204e1
MD5 1eaa1aa5520656a52028e1353dec7a61
BLAKE2b-256 453c1db2a59058f2ab2ef51c70d3b2daa2fb2030a9c09f67496b798997dc2246

See more details on using hashes here.

File details

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

File metadata

  • Download URL: farol_sdk-0.1.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 d052c0c5fbf7a5d40001d5509e3cd9d87ad4c948f3d65ecac1dcaa8ae4306124
MD5 333eaeef5a6976e5622e7e422221f7e1
BLAKE2b-256 eb6633f1a23b31d450baa1d1aff8b7b9a89ed89bc8e515296fc97e76a0f80ae5

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