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

Uploaded Python 3

File details

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

File metadata

  • Download URL: farol_sdk-0.1.4.tar.gz
  • Upload date:
  • Size: 4.4 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.4.tar.gz
Algorithm Hash digest
SHA256 d9e20dbfc43d8ade1ea0bea5b04b0c8d59f7e86d434d46b5e12d9c6e203bd85a
MD5 e4c9c0dfc75bcc73e0846541595d0bc0
BLAKE2b-256 0401976a2ab2d0d82b24ecff36522a94fc3b3537624609efaa873dd817f94861

See more details on using hashes here.

File details

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

File metadata

  • Download URL: farol_sdk-0.1.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1e1f109c4e41c619c886340ea1d66b752b335d08f51576bf9d664f6446ed1716
MD5 13363dc53aae99d03193c0290ea4cde2
BLAKE2b-256 7d1da44d48227e9dd3ffbfbd5466f46f63d1bb20c455ae983771637cae476dc8

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