Skip to main content

A lightweight OpenTelemetry collection and observability library for th2 applications.

Project description

th2pulse

A lightweight OpenTelemetry collection and observability library for th2 applications (th2agent, th2llm, th2etl).

Why

Google ADK (>= 1.36) wires its own OpenTelemetry providers from environment variables and exports rich agent telemetry out of the box: hierarchical spans (invoke_agent → call_llm → generate_content, execute_tool), five native agent metrics, and GenAI event logs — every span tagged with gen_ai.conversation.id and user.id.

What ADK does not do (measured on a real service): bridge standard Python logging records — FastAPI, application code, integrations — to the collector. th2pulse closes that gap with one call, and keeps the whole wiring consistent across th2 services.

Quickstart

export OTEL_EXPORTER_OTLP_ENDPOINT="http://127.0.0.1:4318"   # HTTP port!
export OTEL_SERVICE_NAME="my-service"
import th2pulse

th2pulse.init_observability("my-service")

That's it. Every logging record at INFO+ now reaches the collector, correlated with active traces (trace_id is injected automatically).

Note — the bridge respects your logging configuration: a record only reaches handlers if its logger lets it through. An unconfigured root logger defaults to WARNING, so make sure your app sets its levels (logging.basicConfig(level=logging.INFO) or equivalent) — th2 services already do.

In an ADK app

Call after the ADK app is built so the bridge reuses the provider ADK installed (ADK's own telemetry is already flowing at that point):

app = get_fast_api_app(...)
th2pulse.init_observability("th2agent")

In a plain FastAPI service / worker / script

init_observability installs the logs provider itself. For short-lived scripts, flush before exiting:

th2pulse.init_observability("my-batch")
...
th2pulse.force_flush()

Redacting sensitive content

th2pulse.init_observability(
    "my-service",
    redaction_patterns=[r"Bearer [A-Za-z0-9._-]+", r"api[_-]?key=\S+"],
)

Scrubbing applies to what leaves the process; console output is untouched. Prompt/response content is never captured by default (OTel GenAI redaction).

Correlating non-ADK telemetry with a conversation

from th2pulse import conversation_context

with conversation_context(session_id, user_id=email):
    ...  # spans/logs emitted here join the conversation

Bridged log records emitted inside the context also carry gen_ai.conversation.id / user.id as OTLP log attributes (stamped from baggage by BaggageLogFilter, wired automatically). A log store can therefore filter application logs per conversation directly — no conversation↔trace mapping required. Stores that normalize attribute names (e.g. Loki structured metadata) expose them as gen_ai_conversation_id / user_id.

Ingest service (collector → PostgreSQL → query API)

th2pulse.ingest is the storage/query half of the pipeline: an OTLP/HTTP receiver that persists log records and the conversation ↔ trace mapping in PostgreSQL, then serves them per conversation to the monitoring frontend.

agents / services ──OTLP──▶ collector ──otlphttp (encoding: json)──▶ th2pulse.ingest ──▶ PostgreSQL
                                                                         │
                                                     front ◀── GET /logs?conversation_id=...

Point the collector at it:

exporters:
  otlphttp/pulse:
    endpoint: http://127.0.0.1:4319
    encoding: json          # required — the ingest speaks OTLP/JSON only
service:
  pipelines:
    logs:   { receivers: [otlp], processors: [batch], exporters: [otlphttp/pulse] }
    traces: { receivers: [otlp], processors: [batch], exporters: [otlphttp/pulse] }

Run it:

pip install "th2pulse[ingest]"
export TH2PULSE_DB_DSN="postgresql://user:pass@host:5432/db?sslmode=require"
export TH2PULSE_DB_SCHEMA="my_schema"        # optional
python -m th2pulse.ingest                     # 127.0.0.1:4319

Endpoints:

Route Purpose
POST /v1/logs, /v1/traces OTLP receivers (traces feed the conversation map and span storage)
POST /v1/metrics Accepted and dropped (metrics stay collector-side for now)
GET /logs?conversation_id=&service=&level=&since=&limit=&user_id= Log records, newest first
GET /spans?conversation_id=&limit=&user_id= Spans: tool executions (name, args, response), LLM calls, durations
GET /conversations?user_id= Known conversations with their trace ids
GET /healthz Liveness

Writes are transactional per payload (a collector retry after a failure cannot duplicate committed rows) and span inserts are idempotent (ON CONFLICT DO NOTHING), so replaying an OTLP export is safe. user_id narrows every query to one user's conversations — callers doing authorization (e.g. a frontend proxy) should inject it server-side from a verified identity, never from client input. Optional hardening on top of the localhost-only bind: set TH2PULSE_INGEST_TOKEN and the POST endpoints require a matching X-Th2Pulse-Token header; payloads are capped (10 MB raw, 32 MB decompressed).

The conversation map is built from gen_ai.conversation.id / user.id attributes — on spans (where ADK puts them natively) and on log records (where conversation_context propagates them).

Environment variables

Variable Purpose
OTEL_EXPORTER_OTLP_ENDPOINT Collector base endpoint — use the HTTP port (4318), not gRPC (4317)
OTEL_EXPORTER_OTLP_LOGS_ENDPOINT Logs-specific override (full URL)
OTEL_SERVICE_NAME Service identity on every signal
OTEL_RESOURCE_ATTRIBUTES Extra resource tags (env=dev,...)

Guarantees

  • Opt-in: without an endpoint, init_observability is a no-op.
  • Never breaks the host app: every entry point is best-effort — on failure it warns and returns False.
  • Idempotent: repeated calls attach a single handler.
  • No secrets, no prompts: nothing sensitive is captured by default.

Development

uv sync
uv run pytest

Roadmap

  • Traces/metrics bootstrap for non-ADK services (FastAPI instrumentation).
  • Span storage + retention policies in the ingest service.
  • Structured redaction presets shared across th2 services.

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

th2pulse-0.1.1.tar.gz (38.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

th2pulse-0.1.1-py3-none-any.whl (26.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: th2pulse-0.1.1.tar.gz
  • Upload date:
  • Size: 38.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for th2pulse-0.1.1.tar.gz
Algorithm Hash digest
SHA256 ec7f1adefa12564ad481bbc5978086739ea5dedd7686fb9d4a426f702c6e51c5
MD5 9f24fc79c8fa45f3ba6991818b742655
BLAKE2b-256 43ba327da1a24e3cdf0eb7cadfe201e693d63b16206231499bbf1202b9e7e480

See more details on using hashes here.

Provenance

The following attestation bundles were made for th2pulse-0.1.1.tar.gz:

Publisher: pypi-publish.yml on apowerb/th2pulse

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: th2pulse-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 26.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for th2pulse-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ee4620c653f4bf31ab880eb20dc092632584037ce7ae521adc70b1dfd61e045a
MD5 4b8195204f2cff8dda1b20aa565f55fd
BLAKE2b-256 9463bc22f19b840e83d3fc937586b0674aebfb83ad2865641a0e9396297cd8ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for th2pulse-0.1.1-py3-none-any.whl:

Publisher: pypi-publish.yml on apowerb/th2pulse

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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