Packages

  • package root
    Definition Classes
    root
  • package zio
    Definition Classes
    root
  • package kafka
    Definition Classes
    zio
  • package producer
    Definition Classes
    kafka
  • object ProducerEvent

    Diagnostics events for the Producer.

    Diagnostics events for the Producer.

    The producer always handles records in batches. Even single records results in batches of 1. The diagnostic events are therefore always about batches.

    For each batch the RecordsOffered event is emitted first, followed by the RecordsSent event. Since batches are queued in the producer and sending one batch might go faster than the previous, the two event types can come in any order. However, the RecordsOffered events are always in the order the batches were offered.

    To associate events to a batch you can use the batchId field. This is an ever-increasing number that is unique per producer and starts at 0. When a RecordsOffered and a RecordsSent event are for the same batch, the batchId and records fields have the same value.

    Batches of 0 records do not result in events.

    Definition Classes
    producer
  • ProducedRecord
  • ProducerFinalized
  • RecordsOffered
  • RecordsSent

final case class RecordsSent(batchId: Long, records: Chunk[ProducedRecord], failed: Set[Int]) extends ProducerEvent with Product with Serializable

Diagnostic event that is emitted after all records of a batch were sent to the broker.

The exact time this event is emitted depends on the acks producer configuration. If acks is set to 0, the event is emitted immediately after all records were added to the socket buffer. Other values for acks cause this event to be emitted after the broker has acknowledged the records.

batchId

a unique identifier (for this producer, starting at 0) for this batch of records, can be used to match this diagnostics event with the other diagnostics events for the same batch

records

the records that were attempted to be sent

failed

indices of the records in records of which sending resulted in an error, and those that were not sent because of an earlier error. Records for which the index is not in this set succeeded. When all records succeeded, this set is empty.

Linear Supertypes
Serializable, Product, Equals, ProducerEvent, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RecordsSent
  2. Serializable
  3. Product
  4. Equals
  5. ProducerEvent
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RecordsSent(batchId: Long, records: Chunk[ProducedRecord], failed: Set[Int])

    batchId

    a unique identifier (for this producer, starting at 0) for this batch of records, can be used to match this diagnostics event with the other diagnostics events for the same batch

    records

    the records that were attempted to be sent

    failed

    indices of the records in records of which sending resulted in an error, and those that were not sent because of an earlier error. Records for which the index is not in this set succeeded. When all records succeeded, this set is empty.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val batchId: Long
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val failed: Set[Int]
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. val records: Chunk[ProducedRecord]
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ProducerEvent

Inherited from AnyRef

Inherited from Any

Ungrouped