MCPcopy
hub / github.com/apache/rocketmq

github.com/apache/rocketmq @rocketmq-all-5.5.0 sqlite

repository ↗ · DeepWiki ↗ · release rocketmq-all-5.5.0 ↗
24,599 symbols 128,260 edges 2,225 files 1,279 documented · 5%
README

Apache RocketMQ

Build Status CodeCov Maven Central Release License Average Time to Resolve An Issue Percentage of Issues Still Open Twitter Follow

Apache RocketMQ is a distributed messaging and streaming platform with low latency, high performance and reliability, trillion-level capacity and flexible scalability.

It offers a variety of features:

  • Messaging patterns including publish/subscribe, request/reply and streaming
  • Financial grade transactional message
  • Built-in fault tolerance and high availability configuration options based on DLedger Controller
  • Built-in message tracing capability, also supports opentracing
  • Versatile big-data and streaming ecosystem integration
  • Message retroactivity by time or offset
  • Reliable FIFO and strict ordered messaging in the same queue
  • Efficient pull and push consumption model
  • Million-level message accumulation capacity in a single queue
  • Multiple messaging protocols like gRPC, MQTT, JMS and OpenMessaging
  • Flexible distributed scale-out deployment architecture
  • Lightning-fast batch message exchange system
  • Various message filter mechanics such as SQL and Tag
  • Docker images for isolated testing and cloud isolated clusters
  • Feature-rich administrative dashboard for configuration, metrics and monitoring
  • Authentication and authorization
  • Free open source connectors, for both sources and sinks
  • Lightweight real-time computing

Quick Start

This paragraph guides you through steps of installing RocketMQ in different ways. For local development and testing, only one instance will be created for each component.

Run RocketMQ locally

RocketMQ runs on all major operating systems and requires only a Java JDK version 8 or higher to be installed. To check, run java -version:

$ java -version
java version "1.8.0_121"

For Windows users, click here to download the 5.5.0 RocketMQ binary release, unpack it to your local disk, such as D:\rocketmq. For macOS and Linux users, execute following commands:

# Download release from the Apache mirror
$ wget https://dist.apache.org/repos/dist/release/rocketmq/5.5.0/rocketmq-all-5.5.0-bin-release.zip

# Unpack the release
$ unzip rocketmq-all-5.5.0-bin-release.zip

Prepare a terminal and change to the extracted bin directory:

$ cd rocketmq-all-5.5.0-bin-release/bin

1) Start NameServer

NameServer will be listening at 0.0.0.0:9876, make sure that the port is not used by others on the local machine, and then do as follows.

For macOS and Linux users:

### start Name Server
$ nohup sh mqnamesrv &

### check whether Name Server is successfully started
$ tail -f ~/logs/rocketmqlogs/namesrv.log
The Name Server boot success...

For Windows users, you need to set environment variables first: - From the desktop, right click the Computer icon. - Choose Properties from the context menu. - Click the Advanced system settings link. - Click Environment Variables. - Add Environment ROCKETMQ_HOME="D:\rocketmq".

Then change directory to rocketmq, type and run:

$ mqnamesrv.cmd
The Name Server boot success...

2) Start Broker

For macOS and Linux users:

### start Broker
$ nohup sh mqbroker -n localhost:9876 &

### check whether Broker is successfully started, eg: Broker's IP is 192.168.1.2, Broker's name is broker-a
$ tail -f ~/logs/rocketmqlogs/broker.log
The broker[broker-a, 192.168.1.2:10911] boot success...

For Windows users:

$ mqbroker.cmd -n localhost:9876
The broker[broker-a, 192.168.1.2:10911] boot success...

Run RocketMQ in Docker

You can run RocketMQ on your own machine within Docker containers, host network will be used to expose listening port in the container.

1) Start NameServer

$ docker run -it --net=host apache/rocketmq ./mqnamesrv

2) Start Broker

$ docker run -it --net=host --mount type=bind,source=/tmp/store,target=/home/rocketmq/store apache/rocketmq ./mqbroker -n localhost:9876

Run RocketMQ in Kubernetes

You can also run a RocketMQ cluster within a Kubernetes cluster using RocketMQ Operator. Before your operations, make sure that kubectl and related kubeconfig file installed on your machine.

1) Install CRDs

### install CRDs
$ git clone https://github.com/apache/rocketmq-operator
$ cd rocketmq-operator && make deploy

### check whether CRDs are successfully installed
$ kubectl get crd | grep rocketmq.apache.org
brokers.rocketmq.apache.org                 2022-05-12T09:23:18Z
consoles.rocketmq.apache.org                2022-05-12T09:23:19Z
nameservices.rocketmq.apache.org            2022-05-12T09:23:18Z
topictransfers.rocketmq.apache.org          2022-05-12T09:23:19Z

### check whether operator is running
$ kubectl get pods | grep rocketmq-operator
rocketmq-operator-6f65c77c49-8hwmj   1/1     Running   0          93s

2) Create Cluster Instance

### create RocketMQ cluster resource
$ cd example && kubectl create -f rocketmq_v1alpha1_rocketmq_cluster.yaml

### check whether cluster resources are running
$ kubectl get sts
NAME                 READY   AGE
broker-0-master      1/1     107m
broker-0-replica-1   1/1     107m
name-service         1/1     107m

Apache RocketMQ Community


Learn it & Contact us


Contributing

We always welcome new contributions, whether for trivial cleanups, big new features or other material rewards, more details see here.


License

Apache License, Version 2.0 Copyright (C) Apache Software Foundation


Export Control Notice

This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.

The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.

The following provides more details on the included cryptographic software:

This software uses Apache Commons Crypto (https://commons.apache.org/proper/commons-crypto/) to support authentication, and encryption and decryption of data sent across the network between services.

Extension points exported contracts — how you extend this code

MQAdmin (Interface)
Base interface for MQ management [9 implementers]
client/src/main/java/org/apache/rocketmq/client/MQAdmin.java
NettyRequestProcessor (Interface)
Common remoting command processor [52 implementers]
remoting/src/main/java/org/apache/rocketmq/remoting/netty/NettyRequestProcessor.java
EventMessage (Interface)
The parent class of Event, the subclass needs to indicate eventType. [11 implementers]
controller/src/main/java/org/apache/rocketmq/controller/impl/event/EventMessage.java
CommitLogDispatcher (Interface)
Dispatcher of commit log. [16 implementers]
store/src/main/java/org/apache/rocketmq/store/CommitLogDispatcher.java
ProducerChangeListener (Interface)
producer manager will call this listener when something happen event type: ProducerGroupEvent [21 implementers]
broker/src/main/java/org/apache/rocketmq/broker/client/ProducerChangeListener.java
Node (Interface)
Represent a node which should be mapped to a hash ring [12 implementers]
common/src/main/java/org/apache/rocketmq/common/consistenthash/Node.java
BooleanExpression (Interface)
A BooleanExpression is an expression that always produces a Boolean result. This class was taken from ActiveMQ org.a [22 …
filter/src/main/java/org/apache/rocketmq/filter/expression/BooleanExpression.java
SubCommand (Interface)
(no doc) [101 implementers]
tools/src/main/java/org/apache/rocketmq/tools/command/SubCommand.java

Core symbols most depended-on inside this repo

get
called by 2506
filter/src/main/java/org/apache/rocketmq/filter/expression/EvaluationContext.java
size
called by 1770
broker/src/main/java/org/apache/rocketmq/broker/lite/LiteEventDispatcher.java
add
called by 1312
store/src/main/java/org/apache/rocketmq/store/FlushDiskWatcher.java
error
called by 1303
remoting/src/main/java/org/apache/rocketmq/remoting/netty/NettyLogger.java
info
called by 1232
remoting/src/main/java/org/apache/rocketmq/remoting/netty/NettyLogger.java
put
called by 1014
common/src/main/java/org/apache/rocketmq/common/queue/RoundQueue.java
append
called by 938
client/src/main/java/org/apache/rocketmq/client/trace/TraceDispatcher.java
build
called by 848
auth/src/main/java/org/apache/rocketmq/auth/authorization/builder/AuthorizationContextBuilder.java

Shape

Method 22,033
Class 2,251
Interface 193
Enum 108
Function 14

Languages

Java100%
Python1%

Modules by API surface

common/src/main/java/org/apache/rocketmq/common/BrokerConfig.java476 symbols
store/src/main/java/org/apache/rocketmq/store/config/MessageStoreConfig.java437 symbols
proxy/src/main/java/org/apache/rocketmq/proxy/config/ProxyConfig.java317 symbols
store/src/main/java/org/apache/rocketmq/store/DefaultMessageStore.java226 symbols
broker/src/main/java/org/apache/rocketmq/broker/BrokerController.java190 symbols
client/src/test/java/org/apache/rocketmq/client/impl/MQClientAPIImplTest.java148 symbols
client/src/main/java/org/apache/rocketmq/client/impl/MQClientAPIImpl.java147 symbols
tools/src/main/java/org/apache/rocketmq/tools/admin/DefaultMQAdminExtImpl.java130 symbols
tools/src/main/java/org/apache/rocketmq/tools/admin/DefaultMQAdminExt.java127 symbols
store/src/main/java/org/apache/rocketmq/store/CommitLog.java123 symbols
store/src/main/java/org/apache/rocketmq/store/MessageStore.java118 symbols
store/src/main/java/org/apache/rocketmq/store/timer/TimerMessageStore.java117 symbols

Dependencies from manifests, versioned

${project.groupId}:rocketmq-auth
${project.groupId}:rocketmq-broker
${project.groupId}:rocketmq-client
${project.groupId}:rocketmq-common
${project.groupId}:rocketmq-container
${project.groupId}:rocketmq-controller
${project.groupId}:rocketmq-filter
${project.groupId}:rocketmq-namesrv
${project.groupId}:rocketmq-openmessaging
${project.groupId}:rocketmq-proto
${project.groupId}:rocketmq-proxy
${project.groupId}:rocketmq-remoting

For agents

$ claude mcp add rocketmq \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact