Changelog

0.5.0.0 — 2026-05-05

Breaking Changes

• Tracks the shibuya-core 0.5.0.0 release, which adds an attributes :: !(HashMap Text Attribute) field to the Envelope record exported from Shibuya.Core.Types. The adapter's consumerRecordToEnvelope now populates this field with Kafka-typed OpenTelemetry attributes: messaging.system="kafka" (overrides the framework default of "shibuya"), the typed messaging.kafka.destination.partition (Int64) and messaging.kafka.message.offset (Int64).
• The opt-in module Shibuya.Adapter.Kafka.Tracing is deleted. Its single export traced :: TopicName -> Stream (Eff es) (Ingested es v) -> Stream (Eff es) (Ingested es v) opened a duplicate Consumer-kind span per message under runApp, with the typed Kafka attributes split across the two spans (see plan 9 of the shinzui/shibuya repo, Finding F1). The same job is now done by the framework's processOne, which reads Envelope.attributes and emits exactly one span. Callers that imported traced should remove the import and the traced topic source step; the rest of the wiring (the runApp / runWithMetrics integration) is unchanged.
• The companion test Shibuya.Adapter.Kafka.TracingTest is deleted; its assertions (span shape, attribute set, ack passthrough) move into the framework's Shibuya.Telemetry.SemanticSpec upstream and into this repo's Shibuya.Adapter.Kafka.ConvertTest (the attribute-set assertions, against the envelope produced by consumerRecordToEnvelope in isolation).

Other Changes

• Bumps the shibuya-core build-depends pin to ^>=0.5 in all three packages of this repo (shibuya-kafka-adapter, shibuya-kafka-adapter-bench, shibuya-kafka-adapter-jitsurei).
• The shibuya-kafka-adapter-jitsurei/app/OtelDemo.hs example is refactored to drive its message stream through Shibuya's runWithMetrics, so the framework's processOne opens the per-message span. The pre-deletion traced shape opened a sibling span; the new shape emits exactly one Consumer-kind span per message, parented on the producer's traceparent when present, carrying the spec-aligned messaging attributes plus the typed messaging.kafka.* attributes.
• unordered-containers ^>=0.2 is now a direct build-depends of shibuya-kafka-adapter (library and test stanzas) since Convert.hs constructs the new attribute HashMap.

0.4.0.0 — 2026-04-29

Breaking Changes

• Tracks the shibuya-core 0.4.0.0 release, which adds an attempt :: !(Maybe Attempt) field to the Envelope record exported from Shibuya.Core.Types. The adapter's consumerRecordToEnvelope now sets this field to Nothing, consistent with the upstream guidance that adapters which cannot observe broker-side redeliveries (e.g. Kafka) report Nothing. Downstream code that pattern-matches on Envelope with positional patterns or with non-punned record patterns that name every field must be updated.

Other Changes

• Bumps the shibuya-core build-depends pin to ^>=0.4 in all three packages of this repo.
• Drops three orphan NFData instances (MessageId, Cursor, Envelope a) from shibuya-kafka-adapter-bench/bench/Main.hs; these instances have been provided upstream by shibuya-core since 0.2.0.0 and the orphans had become duplicate-instance hazards whenever the bench resolved against a shibuya-core newer than 0.1.
• shibuya-kafka-adapter-bench and shibuya-kafka-adapter-jitsurei are re-released at 0.4.0.0 to track the shared version of this repo; neither has user-visible changes of its own.

0.3.0.0 — 2026-04-22

Telemetry wire-format change. No Haskell API break — Shibuya.Adapter.Kafka.Tracing.traced's signature is unchanged — but operators with dashboards filtering on the old attribute-key strings or span name must update their queries.

Changed

• Per-message spans now follow the OpenTelemetry messaging semantic-conventions span-name pattern "<destination> <operation>", yielding e.g. "orders process" in place of the previous constant "shibuya.process.message".
• The messaging.operation attribute is now set to "process" on every consumer span.
• The Kafka partition is now emitted as the typed Kafka-specific key messaging.kafka.destination.partition (Int64), replacing the never-defined messaging.destination.partition.id (Text). If the envelope's partition text does not parse as an integer, the shibuya-namespaced shibuya.partition is emitted as a defensive fallback.
• The Kafka offset is now emitted as messaging.kafka.message.offset (Int64), derived from Envelope.cursor when it is a CursorInt.

Aligned with

• Shibuya.Telemetry.Semantic as of sibling shibuya plan 2 (docs/plans/2-align-opentelemetry-semantic-conventions.md in the shibuya repo). Attribute keys for the generic messaging.* namespace are sourced from that module, which in turn derives them from typed AttributeKey values in OpenTelemetry.SemanticConventions.
• OpenTelemetry.SemanticConventions (new direct build-depends) for the typed Kafka-specific keys messaging_kafka_destination_partition and messaging_kafka_message_offset.

0.2.0.0 — 2026-04-18

Additive release. Adds one new exposed module, no changes to existing public types or to kafkaAdapter's signature.

Added

• Shibuya.Adapter.Kafka.Tracing exposing a single stream transformer traced :: (Tracing :> es, IOE :> es) => TopicName -> Stream (Eff es) (Ingested es v) -> Stream (Eff es) (Ingested es v). For each emitted Ingested, traced rewrites the envelope's AckHandle so that when the downstream handler calls finalize the call is enclosed in a Consumer-kind shibuya.process.message span parented on the envelope's carried W3C traceparent (or a root span when absent). The span carries the v1.27 messaging-conventions attribute set (messaging.system, messaging.destination.name, messaging.message.id, and — when partition is known — messaging.destination.partition.id) from Shibuya.Telemetry.Semantic.

• Explicit hs-opentelemetry-api ^>=0.3 build-depends edge on the library. The package was previously in the closure transitively via shibuya-core, but cabal does not let a library import from a transitively-present dependency.

0.1.0.0 — 2026-04-18

Initial release.

shibuya-kafka-adapter bridges Apache Kafka to the Shibuya queue-processing framework. It builds on kafka-effectful for the consumer effect (polling, offset store, partition pause) and hw-kafka-streamly for error classification (skipNonFatal), on top of hw-kafka-client.

Features

• Poll-driven consumer that produces Shibuya Envelope values from Kafka ConsumerRecords.
• Offset-commit semantics combining noAutoOffsetStore, explicit storeOffsetMessage on successful acknowledgement, and librdkafka auto-commit of the stored offsets.
• Partition-aware dispatch: Envelopes carry topic/partition/offset, and AckHalt pauses the originating partition via the consumer effect.
• W3C traceparent / tracestate header extraction from Kafka message headers, surfaced on the Shibuya Envelope for OpenTelemetry propagation.
• Kafka message timestamp conversion to Shibuya's UTCTime representation.
• Graceful shutdown that calls commitAllOffsets so stored offsets are flushed before the consumer handle closes.

Known Limitations

• No automatic partition resume after AckHalt within the consumer session; resumption is left to the operator or the next rebalance.
• No dead-letter queue production. AckDead stores the offset so the stream advances past the poison message but does not publish it anywhere.