Skip to main content

Schema models for the opentraces.ai agent trace JSONL format

Project description

opentraces-schema

Pydantic v2 models for the opentraces.ai JSONL trace format.

Install

pip install opentraces-schema

Usage

from opentraces_schema import TraceRecord, SCHEMA_VERSION

record = TraceRecord(
    trace_id="abc-123",
    session_id="sess-456",
    agent={"name": "claude-code", "version": "1.0.32"},
)
line = record.to_jsonl_line()

Version

The schema version (0.3.0) lives in src/opentraces_schema/version.py as the single source of truth. See VERSION-POLICY.md for semver semantics and the bump checklist.

0.3.0 adds the current commit-correlation surface: GitLink, TraceRecord.lifecycle, TraceRecord.generation_index, TraceRecord.git_links, Task.repository_url, Attribution.revision, Attribution.unaccounted_files, AttributionRange.original, AttributionRange.change_type, AttributionRange.contributor, and AttributionConversation.ids / .related.

Schema Rationale

Every version of the schema ships with a rationale document explaining why each model and field exists, grounded in public standards (ATIF, Agent Trace, ADP, OTel) and empirical observations from real agent traces.

The current rationale is RATIONALE-0.3.0.md. Each version has its own rationale file linked from the CHANGELOG.

Contributing

Schema feedback, questions, and proposals are welcome via GitHub Issues. When suggesting a schema change, please include:

  • What field or model you would add, change, or remove
  • Why it matters for your use case (training, analytics, attribution, etc.)
  • How it relates to existing standards (ATIF, Agent Trace, ADP, OTel) if applicable

Breaking changes (field renames, removals, type changes) require a major version bump. New optional fields and models are minor bumps. See VERSION-POLICY.md for details.

Documentation

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

opentraces_schema-0.3.0.tar.gz (21.1 kB view details)

Uploaded Source

Built Distribution

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

opentraces_schema-0.3.0-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file opentraces_schema-0.3.0.tar.gz.

File metadata

  • Download URL: opentraces_schema-0.3.0.tar.gz
  • Upload date:
  • Size: 21.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for opentraces_schema-0.3.0.tar.gz
Algorithm Hash digest
SHA256 d80f0311312b4a9fac1eef495500be2f6f0d0693b311f79acb46388a7a123496
MD5 077211763799ef31d078893b29125e68
BLAKE2b-256 127c9e9baa033d29ccfc270a37a4b0054a2ef0fb458adf9c4a3a8ebaaa9f1b6b

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentraces_schema-0.3.0.tar.gz:

Publisher: publish.yml on JayFarei/opentraces

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

File details

Details for the file opentraces_schema-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for opentraces_schema-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f52eb5698b50dcf6e3db7773324a68cc396d38c51985765b021c0903db7129ef
MD5 db4e6cc94f0ad7e458f12904ecfb978d
BLAKE2b-256 dbe8d12f8c2a8b3feda83dc5597b9442db3dd0f093c39ea02262bfc77f1d8b8f

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentraces_schema-0.3.0-py3-none-any.whl:

Publisher: publish.yml on JayFarei/opentraces

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