RabbitMQ River 插件技术文档

1. 安装指南

在安装 RabbitMQ River 插件之前，请确保您的 Elasticsearch 版本与插件版本兼容。根据 Elasticsearch 的版本，选择对应的插件版本进行安装。安装命令如下：

bin/plugin install elasticsearch/elasticsearch-river-rabbitmq/版本号

例如，对于 Elasticsearch 1.6 版本，安装命令为：

bin/plugin install elasticsearch/elasticsearch-river-rabbitmq/2.6.0

若需要构建 SNAPSHOT 版本，可以使用以下 Maven 命令：

mvn clean install
plugin --install river-rabbitmq \
       --url file:target/releases/elasticsearch-river-rabbitmq-X.X.X-SNAPSHOT.zip

2. 项目的使用说明

RabbitMQ River 插件允许将 RabbitMQ 消息队列中的消息以 Elasticsearch 的批量格式索引到 Elasticsearch 中。以下是创建 RabbitMQ River 的基本步骤：

curl -XPUT 'localhost:9200/_river/my_river/_meta' -d '{
    "type" : "rabbitmq",
    "rabbitmq" : {
        "host" : "localhost",
        "port" : 5672,
        "user" : "guest",
        "pass" : "guest",
        "vhost" : "/",
        "queue" : "elasticsearch",
        "exchange" : "elasticsearch",
        "routing_key" : "elasticsearch",
        "exchange_declare" : true,
        "exchange_type" : "direct",
        "exchange_durable" : true,
        "queue_declare" : true,
        "queue_bind" : true,
        "queue_durable" : true,
        "queue_auto_delete" : false,
        "heartbeat" : "30m",
        "qos_prefetch_size" : 0,
        "qos_prefetch_count" : 10,
        "nack_errors" : true
    },
    "index" : {
        "bulk_size" : 100,
        "bulk_timeout" : "10ms",
        "ordered" : false,
        "replication" : "default"
    }
}'

3. 项目API使用文档

RabbitMQ River 插件支持以下配置选项：

• exchange_declare：是否声明交换机（默认为 true）。
• exchange_type：交换机类型（默认为 direct）。
• exchange_durable：交换机是否持久化（默认为 true）。
• queue_declare：是否声明队列（默认为 true）。
• queue_bind：是否绑定队列（默认为 true）。
• queue_durable：队列是否持久化（默认为 true）。
• queue_auto_delete：队列是否自动删除（默认为 false）。
• heartbeat：心跳时间（默认为 30m）。
• qos_prefetch_size：QoS 预取大小（默认为 0，即无限）。
• qos_prefetch_count：QoS 预取计数（默认为 10）。
• nack_errors：是否在错误发生时拒绝消息（默认为 true）。

此外，还支持以下索引配置选项：

• bulk_size：批量大小（默认为 100）。
• bulk_timeout：批量超时时间（默认为 10ms）。
• ordered：是否有序（默认为 false）。
• replication：复制模式（默认为 default）。

4. 项目安装方式

RabbitMQ River 插件的安装方式已在“安装指南”部分详细介绍，此处不再赘述。需要注意的是，安装时要确保插件版本与 Elasticsearch 版本兼容。安装命令如下：

bin/plugin install elasticsearch/elasticsearch-river-rabbitmq/版本号

例如，对于 Elasticsearch 1.6 版本，安装命令为：

bin/plugin install elasticsearch/elasticsearch-river-rabbitmq/2.6.0