sentry-kafka-schemas

What it is and what it does

sentry-kafka-schemas is a schema registry and codec library for Sentry's Kafka infrastructure. It defines the topics, JSON schemas, and message formats that Sentry services use to stream events and metrics through Kafka, along with validation and type-generation tooling. The package contains YAML topic definitions, jsonschema files for both JSON and msgpack message types, and example payloads stripped of customer data.

When installed, it provides a Python API to retrieve codecs for specific topics (e.g., `get_codec("ingest-metrics")`), validate incoming messages against their schemas, and access auto-generated TypedDict classes that correspond to each schema version. This allows Sentry services and integrations to encode, decode, and validate Kafka messages with type safety and schema compliance.

Use it for:

• Validate incoming Kafka messages in a Sentry service consumer against the canonical schema before processing.
• Generate type-safe Python objects from Kafka payloads using auto-generated schema_types classes.
• Encode outgoing events or metrics to Kafka with schema validation to prevent malformed messages.
• Reference topic definitions and examples during development of new Sentry services that produce or consume Kafka topics.
• Synchronize schema definitions across Sentry, Snuba, and Relay services during schema evolution.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides Kafka topic definitions and JSON schema validators for Sentry's event streaming infrastructure, with auto-generated Python type hints for schema-compliant message handling.

Yes, if you are developing or operating a Sentry instance or integration that produces or consumes Kafka messages. The package is actively maintained, has low install friction, and provides essential schema definitions and validation for Sentry's event pipeline. Verify the license status before use in proprietary contexts, and confirm Python version compatibility for your environment.

Install

sentry-kafka-schemas on PyPI

pip install sentry-kafka-schemas

uv add sentry-kafka-schemas

poetry add sentry-kafka-schemas

Installing sentry-kafka-schemas

Before you install

Active maintenance with a release on 2026-08-14. Low install friction: pure Python wheel with six runtime dependencies (python-rapidjson, PyYAML, typing-extensions, fastjsonschema, msgpack, sentry-protos). No minimum Python version specified in the fact sheet.

License in practice

License treatment is unclear—no SPDX identifier or raw license text is provided. Verify the actual license before using in proprietary or GPL-sensitive contexts.

Quickstart

pip install sentry-kafka-schemas

from sentry_kafka_schemas import get_codec, ValidationError
from sentry_kafka_schemas.schema_types.ingest_metrics_v1 import IngestMetric

SCHEMA = get_codec("ingest-metrics")
try:
    decoded = SCHEMA.decode(b'{"type": "c", ...}')
except ValidationError:
    pass

Verify before relying

• Minimum Python version required (requires_python is unspecified in the fact sheet)
• Whether license is open-source or proprietary (license_treatment is 'unclear')
• Stability guarantees for schema versioning and backward compatibility across releases

Package facts

Evidence: sentry_kafka_schemas-3.0.0-py2.py3-none-any.whl

Tags

More Distributed Computing packages