Connect
Self-Managed Only

zmq4

Consumes messages from a ZeroMQ socket.

This component links to the ZeroMQ C library (libzmq), so only cgo builds of Redpanda Connect include it. The standard release binaries, rpk connect, and the Docker images don’t include it.

To get a build that includes this component, either download the redpanda-connect-cgo_<version>_linux_amd64.tar.gz archive from the Redpanda Connect releases, or build from source with cgo enabled and the x_benthos_extra build tag:

# Install the libzmq headers first, for example on Debian or Ubuntu
sudo apt-get install libzmq3-dev

CGO_ENABLED=1 go build -tags x_benthos_extra,timetzdata ./cmd/redpanda-connect

Both builds link libzmq dynamically, so the machine that runs Redpanda Connect also needs the ZeroMQ shared library installed.

  • Common

  • Advanced

input:
  label: ""
  zmq4:
    urls: [] # No default (required)
    bind: false
    socket_type: "" # No default (required)
    sub_filters: []
input:
  label: ""
  zmq4:
    urls: [] # No default (required)
    bind: false
    socket_type: "" # No default (required)
    sub_filters: []
    high_water_mark: 0
    poll_timeout: 5s

This component is available only in builds of Redpanda Connect that enable cgo. The standard release binaries, the Docker images, and the standard rpk connect plugin don’t include it. To use it, do one of the following:

  • Download the redpanda-connect-cgo_<version>_linux_amd64 archive from the GitHub releases page. This archive is available for Linux AMD64 only.

  • Build Redpanda Connect from source with CGO_ENABLED=1 go build -tags x_benthos_extra,timetzdata ./cmd/redpanda-connect. The build needs a C compiler.

The cgo archive and the source build both need the ZeroMQ library (libzmq), because they include the zmq4 components.

Fields

bind

Whether to bind to the URLs and wait for peers to connect, instead of connecting to them.

Type: bool

Default: false

high_water_mark

The message high water mark to use.

Type: int

Default: 0

poll_timeout

The poll timeout to use.

Type: string

Default: 5s

socket_type

The socket type to connect as.

Type: string

Options: PULL, SUB

sub_filters[]

The topics that the socket subscribes to when socket_type is SUB. ZeroMQ delivers a message only when its first frame begins with one of these prefixes, so specifying a single sub_filter of '' subscribes to everything. At least one filter is required with a SUB socket.

Type: array<string>

Default: []

urls[]

A list of ZeroMQ endpoints to connect to, or to bind when bind is true, using a transport such as tcp://, ipc://, or inproc://. If an item in the list contains commas, it is split into multiple endpoints.

Type: array<string>

# Examples:
urls:
  - "tcp://localhost:5555"