helixobs 0.2.2

Entity-centric observability client for scientific instrument pipelines

helixobs — Python client

Entity-centric observability for scientific instrument pipelines.

Track domain entities (raw observations, intermediate products, derived results) across disjoint asynchronous pipeline stages. The library attaches provenance links between entities so you can trace any scientific result back to the raw data that produced it.

Built on OpenTelemetry. Signals are standard OTLP — the HelixObs gateway adds entity intelligence on top.

Installation

pip install helixobs

Requires Python 3.11+.

Quick start

from helixobs import Instrument
from helixobs.logging import configure_logging
import logging

configure_logging()
log = logging.getLogger("my.pipeline")

tel = Instrument(
    service_name="my-instrument.pipeline",
    instrument_id="MY_INSTRUMENT",
    endpoint="gateway:4317",
)

# Track an entity through a pipeline stage
with tel.create("detector", id=product_id, parents=[frame_id]) as token:
    result = process(item)
    log.info("item processed")           # helix_entity_id injected automatically
    if result.score > 0.95:
        token.add_event("helix.event.detection_confirmed", {"score": result.score})
# complete() called on exit; error() called on unhandled exception

See USER_GUIDE.md for the full API reference, integration patterns, structured logging, and data model.

Development

pip install -e ".[dev]"
pytest