Module: Rdkafka::Defaults

Defined in:

lib/rdkafka/defaults.rb

Overview

Note:

These are rdkafka-ruby defaults, not librdkafka configuration options. For librdkafka options, see: github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md

Default timeout and timing values used throughout rdkafka-ruby.

All timeout values can be overridden per-call via method parameters. These constants provide a central place to understand and reference the default values used across the library.

Examples:

Overriding a timeout per-call

consumer.committed(timeout_ms: 5_000)  # Use 5 seconds instead of default 2 seconds

Checking the default value

Rdkafka::Defaults::CONSUMER_COMMITTED_TIMEOUT_MS  # => 2000

Constant Summary

CONSUMER_COMMITTED_TIMEOUT_MS =

Default timeout for fetching committed offsets

See Also:

• Consumer#committed

2_000

CONSUMER_QUERY_WATERMARK_TIMEOUT_MS =

Default timeout for querying watermark offsets

See Also:

• Consumer#query_watermark_offsets

1_000

CONSUMER_LAG_TIMEOUT_MS =

Default timeout for lag calculation watermark queries

See Also:

• Consumer#lag

1_000

CONSUMER_OFFSETS_FOR_TIMES_TIMEOUT_MS =

Default timeout for offsets_for_times operation

See Also:

• Consumer#offsets_for_times

1_000

CONSUMER_POLL_TIMEOUT_MS =

Default poll timeout for Consumer#each iterator

See Also:

• Consumer#each

250

CONSUMER_SEEK_TIMEOUT_MS =

Seek operation timeout (0 = non-blocking)

See Also:

• Consumer#seek_by

0

CONSUMER_EVENTS_POLL_TIMEOUT_MS =

Events poll timeout (0 = non-blocking/async)

See Also:

• Consumer#events_poll

0

PRODUCER_FLUSH_TIMEOUT_MS =

Default timeout for producer flush operation

See Also:

• Producer#flush

5_000

PRODUCER_PURGE_FLUSH_TIMEOUT_MS =

Default flush timeout during purge operation

See Also:

• Producer#purge

100

METADATA_TIMEOUT_MS =

Default timeout for metadata requests

See Also:

• Admin#metadata
• Metadata#initialize

2_000

HANDLE_WAIT_TIMEOUT_MS =

Default maximum wait timeout for async handles (delivery, admin operations)

See Also:

• AbstractHandle#wait

60_000

NATIVE_KAFKA_POLL_TIMEOUT_MS =

Default poll timeout for producer/admin native polling thread

See Also:

• Config#producer
• Config#admin

100

PRODUCER_PURGE_SLEEP_INTERVAL_MS =

Sleep interval during purge wait loop

See Also:

• Producer#purge

1

NATIVE_KAFKA_SYNCHRONIZE_SLEEP_INTERVAL_MS =

Sleep interval while waiting for operations to complete in NativeKafka#synchronize

See Also:

• NativeKafka#synchronize

10

METADATA_RETRY_BACKOFF_BASE_MS =

Base backoff factor for metadata retry in milliseconds (multiplied by 2^attempt)

See Also:

• Metadata#initialize

100

PARTITIONS_COUNT_CACHE_TTL_MS =

Default time-to-live for cached partition counts

See Also:

• Producer::PartitionsCountCache

30_000

METADATA_MAX_RETRIES =

Maximum number of metadata fetch retry attempts

See Also:

• Metadata#initialize

10