Skip to content

Commit

Permalink
Add *Rabbit source connector guide* (apache#5255)
Browse files Browse the repository at this point in the history
  • Loading branch information
Anonymitaet authored and Jennifer88huang-zz committed Sep 27, 2019
1 parent 0fac91c commit a20d57d
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 54 deletions.
77 changes: 77 additions & 0 deletions site2/docs/io-rabbitmq-source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
id: io-rabbitmq
title: RabbitMQ source connector
sidebar_label: RabbitMQ source connector
---

The RabbitMQ source connector receives messages from RabbitMQ clusters
and writes messages to Pulsar topics.

## Configuration

The configuration of the RabbitMQ source connector has the following properties.

### Property

| Name | Type|Required | Default | Description
|------|----------|----------|---------|-------------|
| `connectionName` |String| true | " " (empty string) | The connection name. |
| `host` | String| true | " " (empty string) | The RabbitMQ host. |
| `port` | int |true | 5672 | The RabbitMQ port. |
| `virtualHost` |String|true | / | The virtual host used to connect to RabbitMQ. |
| `username` | String|false | guest | The username used to authenticate to RabbitMQ. |
| `password` | String|false | guest | The password used to authenticate to RabbitMQ. |
| `queueName` | String|true | " " (empty string) | The RabbitMQ queue name that messages should be read from or written to. |
| `requestedChannelMax` | int|false | 0 | The initially requested maximum channel number. <br><br>0 means unlimited. |
| `requestedFrameMax` | int|false |0 | The initially requested maximum frame size in octets. <br><br>0 means unlimited. |
| `connectionTimeout` | int|false | 60000 | The timeout of TCP connection establishment in milliseconds. <br><br>0 means infinite. |
| `handshakeTimeout` | int|false | 10000 | The timeout of AMQP0-9-1 protocol handshake in milliseconds. |
| `requestedHeartbeat` | int|false | 60 | The requested heartbeat timeout in seconds. |
| `prefetchCount` | int|false | 0 | The maximum number of messages that the server delivers.<br><br> 0 means unlimited. |
| `prefetchGlobal` | boolean|false | false |Whether the setting should be applied to the entire channel rather than each consumer. |

### Example

Before using the RabbitMQ source connector, you need to create a configuration file through one of the following methods.

* JSON

```json
{
"host": "localhost",
"port": "5672",
"virtualHost": "/",
"username": "guest",
"password": "guest",
"queueName": "test-queue",
"connectionName": "test-connection",
"requestedChannelMax": "0",
"requestedFrameMax": "0",
"connectionTimeout": "60000",
"handshakeTimeout": "10000",
"requestedHeartbeat": "60",
"prefetchCount": "0",
"prefetchGlobal": "false"
}
```

* YAML

```yaml
configs:
host: "localhost"
port: 5672
virtualHost: "/",
username: "guest"
password: "guest"
queueName: "test-queue"
connectionName: "test-connection"
requestedChannelMax: 0
requestedFrameMax: 0
connectionTimeout: 60000
handshakeTimeout: 10000
requestedHeartbeat: 60
prefetchCount: 0
prefetchGlobal: "false"
```

54 changes: 0 additions & 54 deletions site2/docs/io-rabbitmq.md

This file was deleted.

0 comments on commit a20d57d

Please sign in to comment.