In-process agent observability sensor for Flightdeck
Project description
flightdeck-sensor
In-process agent observability sensor for Flightdeck.
Local development venv
Flightdeck pins Python 3.12 for local development. The project
bound is 3.10 ≤ x < 3.14 (pyproject requires-python); sensor/.venv
is the canonical interpreter for every Make target that runs Python.
Recreate from a fresh clone or after a rm -rf sensor/.venv:
python3.12 -m venv sensor/.venv
./sensor/.venv/bin/python -m pip install -e ".[dev,anthropic,openai]"
make -C sensor install does the same once the venv exists. CI
overrides via env (PYTHON=python make -C sensor test) where
actions/setup-python already pinned the interpreter.
Optional session_id hint (D094)
By default init() auto-generates a fresh UUID every time the process
starts. Orchestrators that re-run the same logical workflow (Temporal,
Airflow, cron) can instead pass a stable identifier; if the backend
already has a row for that session, the new execution is attached to it
and appears as a continuation of the prior run in the fleet view.
Supply the hint via either the session_id= kwarg or the
FLIGHTDECK_SESSION_ID environment variable. The env var takes
precedence.
The value MUST parse as a canonical UUID (any version) -- the
sessions table column is UUID-typed. If you pass a non-UUID the
sensor logs a warning and falls back to auto-generating one.
Orchestrators that use string identifiers (Temporal workflow_id,
Airflow dag_run_id) should hash the identifier into a deterministic
UUID with uuid.uuid5.
Temporal workflow example
import uuid
import flightdeck_sensor as fd
from temporalio import workflow
# Pick any fixed namespace UUID for your deployment. The same
# workflow_id + namespace always produces the same session UUID,
# so re-runs of the same workflow all map to the same sessions row.
FLIGHTDECK_NS = uuid.UUID("00000000-0000-0000-0000-000000000001")
@workflow.defn
class MyWorkflow:
@workflow.run
async def run(self, input):
ctx = workflow.info()
fd.init(
server="http://flightdeck.internal/ingest",
token="ftd_...",
session_id=str(uuid.uuid5(FLIGHTDECK_NS, ctx.workflow_id)),
)
# If this workflow_id has run before, the backend attaches
# this execution to the existing session automatically; the
# sensor logs INFO on the first response that confirms it.
...
The sensor logs a single WARNING at init() time whenever a custom
session_id is in play so the behaviour is visible in operational
logs, and an INFO line on the first response where the backend
confirms attachment. See DECISIONS.md D094 and ARCHITECTURE.md
("Session attachment flow") for the full protocol.
Framework support
flightdeck_sensor.patch() installs three class-level (or module-
level) interceptors process-wide. Every LLM call that flows through
a patched entry point emits a pre_call / post_call event pair
without any framework-specific wiring.
| Framework | Interceptor | Entry points |
|---|---|---|
Anthropic SDK (direct or via a framework that constructs Anthropic() internally — LangChain, LlamaIndex, CrewAI native) |
patch_anthropic_classes |
Anthropic.messages.create / .stream, async + sync, beta resources |
OpenAI SDK (direct or via a framework that constructs OpenAI() internally — LangChain, LlamaIndex, CrewAI native) |
patch_openai_classes |
OpenAI.chat.completions.create, .responses.create, .embeddings.create, async + sync |
| litellm (router that aggregates many providers behind one function surface) | patch_litellm_functions |
litellm.completion, litellm.acompletion |
litellm example (KI21)
litellm's Anthropic route uses raw httpx instead of the Anthropic
SDK, so it bypasses the SDK-class patches. The litellm interceptor
patches litellm.completion / litellm.acompletion directly to
close this gap. An Anthropic model string via litellm exercises the
bypass case:
import flightdeck_sensor
import litellm
flightdeck_sensor.init(
server="http://flightdeck.internal/ingest", token="ftd_...",
)
flightdeck_sensor.patch()
# After patch(), this call routes through the sensor's pre/post-call
# plumbing regardless of which underlying provider litellm picks for
# the model string.
response = litellm.completion(
model="claude-haiku-4-5-20251001",
messages=[{"role": "user", "content": "hi"}],
max_tokens=5,
)
Install the optional dependency: pip install flightdeck-sensor[litellm].
What the litellm interceptor catches, and what it doesn't
Catches. Direct callers of litellm.completion(**kwargs) and
litellm.acompletion(**kwargs) — the vast majority of litellm
integrations, including the default chat-completion surface exposed
by user code, Router, and frameworks that route through the public
API (CrewAI non-native flavors, langchain-community's litellm
adapter, etc.).
Does NOT catch.
- Streaming.
stream=TrueraisesNotImplementedErrorin v1 with a pointer to KI26 (the tracked follow-up). Usestream=Falseor reconstruct the stream downstream of the call. - Lower-level litellm entry points. Some integrations reach
past
completionintolitellm.llms.custom_httpx.http_handleror other internal helpers directly. Those calls bypass the module-level wrapper. A broader httpx-level interceptor was considered during the KI21 scoping and deferred — if framework reports surface calls that slip past the current coverage, file a new issue. - Embeddings (
litellm.embedding/aembedding). Not wrapped in v1. Out of scope; embeddings have no policy/budget surface in the current session layer. litellm.text_completion. Legacy completion API, not wrapped.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file flightdeck_sensor-0.5.2.tar.gz.
File metadata
- Download URL: flightdeck_sensor-0.5.2.tar.gz
- Upload date:
- Size: 205.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
45de28802ab8478b8da8758c4c7c8592d0afc2a1910e280d0a96b257d6d5e4c4
|
|
| MD5 |
f269be1093dce76108d716120ef2ea50
|
|
| BLAKE2b-256 |
1bd5eb511424ac83c0d7a50948a812471866bf9434eaf732aa216ba3c76d0c95
|
Provenance
The following attestation bundles were made for flightdeck_sensor-0.5.2.tar.gz:
Publisher:
release.yml on flightdeckhq/flightdeck
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
flightdeck_sensor-0.5.2.tar.gz -
Subject digest:
45de28802ab8478b8da8758c4c7c8592d0afc2a1910e280d0a96b257d6d5e4c4 - Sigstore transparency entry: 1678613554
- Sigstore integration time:
-
Permalink:
flightdeckhq/flightdeck@7ccd7f886aa52ebe1abf83fade009b77957cd078 -
Branch / Tag:
refs/tags/v0.5.2 - Owner: https://github.com/flightdeckhq
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@7ccd7f886aa52ebe1abf83fade009b77957cd078 -
Trigger Event:
push
-
Statement type:
File details
Details for the file flightdeck_sensor-0.5.2-py3-none-any.whl.
File metadata
- Download URL: flightdeck_sensor-0.5.2-py3-none-any.whl
- Upload date:
- Size: 146.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2e093d5eba222bfdebf13289e6bdfa0d51740dac93b595e5ecb7074db21a7ee6
|
|
| MD5 |
66ef2e79c6ebd1953ddcc0fbf43f410a
|
|
| BLAKE2b-256 |
15cf07376b70776fc1edf922fa97ac1033c7cf1adadf31f98d4f07c67a5ffe7b
|
Provenance
The following attestation bundles were made for flightdeck_sensor-0.5.2-py3-none-any.whl:
Publisher:
release.yml on flightdeckhq/flightdeck
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
flightdeck_sensor-0.5.2-py3-none-any.whl -
Subject digest:
2e093d5eba222bfdebf13289e6bdfa0d51740dac93b595e5ecb7074db21a7ee6 - Sigstore transparency entry: 1678613748
- Sigstore integration time:
-
Permalink:
flightdeckhq/flightdeck@7ccd7f886aa52ebe1abf83fade009b77957cd078 -
Branch / Tag:
refs/tags/v0.5.2 - Owner: https://github.com/flightdeckhq
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@7ccd7f886aa52ebe1abf83fade009b77957cd078 -
Trigger Event:
push
-
Statement type: