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

Uploaded Python 3

File details

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

File metadata

  • Download URL: farol_sdk-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 499de64a1ee30cac1431ce6dc6b349463987e79862a44cc5f565beb8f766e27b
MD5 ee21e4d02481602d9301cadd4a3f309d
BLAKE2b-256 aef7edd2f5986031d4f20b8fbf3a488587cd7bdca2c6d322baa126ae58c0511d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: farol_sdk-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 663fcb701268df5b0e9999285ae67a46dfcd558061ff402155012503b08b6c65
MD5 4dc77f5d41f0249b36ede9ec54f88785
BLAKE2b-256 c4377dad718c935d5b8e3f2942801bfdee39feb35b94818717c1106336142592

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