Skip to main content

Protocol buffers and gRPC stubs for integrating Chaukas agent observability into your SDKs

Project description

Chaukas Spec Client

Protocol buffers and gRPC stubs for integrating Chaukas agent observability into your SDKs

PyPI version Python 3.9+ License

What is this?

chaukas-spec-client provides the client-side Protocol Buffer definitions and gRPC service stubs for the Chaukas agent observability platform. Use this package to:

  • Instrument your AI agent SDKs with standardized event tracking
  • Send telemetry data to Chaukas-compatible backends
  • Track 19+ event types across agent lifecycles, model invocations, tool calls, and errors
  • Enable distributed tracing with full trace context propagation
  • Ensure compliance with immutable audit trails

Who should use this?

  • SDK developers building agent frameworks who want to add observability
  • Agent builders integrating telemetry into custom agents
  • Platform teams sending events from client applications to observability backends

Note: If you're implementing an observability backend/platform, use chaukas-spec-server instead.

Installation

pip install chaukas-spec-client

Quick Start

import grpc
from chaukas.spec.client.v1.client_pb2_grpc import ChaukasClientServiceStub
from chaukas.spec.client.v1.client_pb2 import IngestEventRequest
from chaukas.spec.common.v1.events_pb2 import Event, EventType

# Create gRPC channel to your Chaukas backend
channel = grpc.insecure_channel('localhost:50051')
stub = ChaukasClientServiceStub(channel)

# Create and send an event
event = Event(
    event_id="evt_123",
    type=EventType.EVENT_TYPE_AGENT_START,
    session_id="session_abc",
    trace_id="trace_xyz"
)

request = IngestEventRequest(event=event)
response = stub.IngestEvent(request)

Event Types

The specification includes comprehensive event types for agent observability:

Category Event Types
Session SESSION_START, SESSION_END
Agent AGENT_START, AGENT_END, AGENT_HANDOFF
Model MODEL_INVOCATION_START, MODEL_INVOCATION_END
Tools TOOL_CALL_START, TOOL_CALL_END, MCP_CALL_START, MCP_CALL_END
I/O INPUT_RECEIVED, OUTPUT_EMITTED
Errors ERROR, RETRY
Extensions POLICY_DECISION, DATA_ACCESS, STATE_UPDATE, SYSTEM

Features

Standardized Schema - Protocol Buffer definitions for all event types ✅ gRPC Services - High-performance service stubs for event ingestion ✅ Type Safety - Full type hints and validation ✅ Distributed Tracing - Built-in trace context support ✅ Batch Operations - Efficient batch event ingestion ✅ Query Support - Query events by session, trace, time range, and more

Package Contents

chaukas/spec/
├── client/v1/       # Client gRPC service stubs
│   ├── client_pb2.py
│   └── client_pb2_grpc.py
└── common/v1/       # Shared event definitions
    ├── events_pb2.py
    └── query_pb2.py

Documentation

Related Packages

  • chaukas-sdk - One-line instrumentation for popular agent frameworks
  • chaukas-spec-server - Server-side implementation for building observability backends

Contributing

We welcome contributions! Please see our Contributing Guide and Code of Conduct.

License

Apache 2.0 - See LICENSE for details.

Support

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

chaukas_spec_client-1.0.5.tar.gz (25.9 kB view details)

Uploaded Source

Built Distribution

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

chaukas_spec_client-1.0.5-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

Details for the file chaukas_spec_client-1.0.5.tar.gz.

File metadata

  • Download URL: chaukas_spec_client-1.0.5.tar.gz
  • Upload date:
  • Size: 25.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for chaukas_spec_client-1.0.5.tar.gz
Algorithm Hash digest
SHA256 be6264ba7534f65367707e9495522513eefbb44c0de71b93def1106cfe114dba
MD5 cab5155c8825ef215e0aab9d0acfc89a
BLAKE2b-256 ed54a38f37f0bc8a7e1a18d683e3ff521f7804365cdf9d211d9c4dd34389844f

See more details on using hashes here.

Provenance

The following attestation bundles were made for chaukas_spec_client-1.0.5.tar.gz:

Publisher: release.yml on chaukasai/chaukas-spec

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

File details

Details for the file chaukas_spec_client-1.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for chaukas_spec_client-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8a55af69cf6c1e86472b7544adc2abb508ebb8d228d3beb5bde84179ee8afc57
MD5 4011780b9ef6110c60379b84041c2a6f
BLAKE2b-256 9c370f9e66ef511da922eb9aadea34fa548fc949958f8dd0443bca6e09611981

See more details on using hashes here.

Provenance

The following attestation bundles were made for chaukas_spec_client-1.0.5-py3-none-any.whl:

Publisher: release.yml on chaukasai/chaukas-spec

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