Monitoring Apache RocketMQ (private preview)
After you install the Instana host agent, Apache RocketMQ Sensor is automatically installed. You can view metrics that are related to Apache RocketMQ in the Instana UI after you configure the Apache RocketMQ Sensor as outlined in the Configuring section.
Supported information
Supported operating systems
The supported operating systems of the Apache RocketMQ sensor are consistent with the requirements of the host agents. To find the supported operating systems for every host agent, see the Supported operating systems section of each host agent, such as Supported operating systems for Linux.
- The Apache RocketMQ sensor uses remote monitoring mechanism, and thus it supports all those operating systems that the host agent supports. These supported operating systems are for Apache RocketMQ sensor, not for Apache RocketMQ.
- Instana provides tracing support for only Linux operating systems on the x86_64 architecture.
Supported Apache RocketMQ versions and platforms
Instana supports tracing, metrics, and configuration data for Apache RocketMQ 4.9.x that is installed in the following platforms:
| Operating system | Hardware |
|---|---|
| Red Hat Enterprise Linux (RHEL) 9 | x86-64 |
| Red Hat Enterprise Linux (RHEL) 8 | x86-64 |
| Red Hat Enterprise Linux (RHEL) 7 | x86-64 |
Supported client-side tracing
Instana supports client-side tracing for Java.
Configuring
The Apache RocketMQ sensor can be disabled, and it can be filtered by tags and resource groups. You can configure the Apache RocketMQ sensor by using the agent configuration in the
<agentinstall_dir>/etc/instana/configuration.yaml file.
To enable the Apache RocketMQ sensor and set the AccessKey pair, configure the agent's configuration.yaml file as follows:
com.instana.plugin.rocketmq:
# Valid values: true, false
enabled: true
poll_rate: 60
nameServerClusters:
# Name server IP:port (required)
- namesrvAddr: 'ip1:9876'
availabilityZone: 'rocketmqzone'
enableACL: false # Whether to enable access control. Default is false.
accessKey: '' # The accessKey is used to verify the identity of the user.
secretKey: '' # The secretKey is used to encrypt and verify the signature string.
Viewing metrics
To view the metrics, complete the following steps:
- In the sidebar of the Instana UI, select Infrastructure.
- Click a specific monitored host.
Then, you can see a host dashboard with all the collected metrics and monitored processes.
The Apache RocketMQ sensor collects only basic metrics for brokers and topics.
Configuration data
The configuration data provides the Apache RocketMQ cluster name and name server address.
| RocketMQ details | Description |
|---|---|
| Cluster Name | Name of broker cluster |
| Name Server Address | Name server of RocketMQ cluster |
Performance metrics
The performance metrics include basic metrics for brokers and topics.
Broker metrics
The following metrics are provided for each broker.
| Broker metric | Description |
|---|---|
| putNums | Put message TPS |
| getNums | Get message TPS |
| putMessageEntireTimeMax | commitLogDiskRatioPut elapsed time Max |
| putMessageTimesTotal | Put elapsed time Total |
| putMessageSizeTotal | Put message size Total |
| putMessageFailedTimes | Put failed times |
| getMessageEntireTimeMax | Get elapsed time Max |
| putTps60 | Put TPS in the last 1 min |
| getFoundTps60 | Get found TPS in the last 1 min |
| getMissTps60 | Get miss TPS in the last 1 min |
| getTotalTps60 | Get total TPS in the last 1 min |
| getTransferedTps60 | Get transferred TPS in the last 1 min |
| msgGetTotalTodayNow | Today Produce Count |
| msgPutTotalTodayNow | Today Consume Count |
| sendThreadPoolQueueHeadWaitTimeMills | Send queue head element wait time |
| pullThreadPoolQueueHeadWaitTimeMills | Pull queue head element wait time |
| queryThreadPoolQueueHeadWaitTimeMills | Query queue head element wait time |
| queryThreadPoolQueueSize | Query queue size |
| pullThreadPoolQueueSize | Pull queue size |
| sendThreadPoolQueueSize | Send queue size |
| commitLogDiskRatio | Commit log disk ratio |
Topic metrics
The following metrics are provided for each topic.
| Topic metric | Description |
|---|---|
| putNums | Put message TPS, sum of topicPutNums |
| putMessageSize | Put message size, sum of topicPutMessageSize |
| getNums | Get message TPS, sum of GroupGetNums |
| getMessageSize | Get message size, sum of GroupGetMessageSize |
| sendBackNums | Resend times, sum of SendBackNums |
Tracing
For automatic tracing of all requests, see Tracing - supported technologies.