Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Using the rabbitmq_tracing Plug-in

Updated on 2024-10-30 GMT+08:00

The rabbitmq_tracing plug-in provides the message tracing function. It traces incoming and outgoing messages of RabbitMQ, captures the messages, and saves message logs to the corresponding trace file.

The rabbitmq_shovel plug-in can be enabled only for single-node RabbitMQ instances with SSL disabled, and not for cluster instances or single-node instances with SSL enabled.

Operation Impact

  • The tracing log files may use up the disk space. You are advised not to enable the rabbitmq_tracing plug-in for heavy-load instances.
  • The disk space occupied by tracing log files is freed only after the plug-in is disabled. Do not enable the plug-in for long term. After the fault is located, close the tracing task and plug-in.

Prerequisites

You have purchased an instance.

Using the rabbitmq_tracing Plug-in

  1. Enable the rabbitmq_tracing plug-in by referring to Enabling RabbitMQ Plug-ins.
  2. Log in to the RabbitMQ management UI.
  3. On the top navigation bar, choose Admin.
  4. In the navigation tree on the right, choose Virtual Hosts.

    Figure 1 Virtual Hosts page

  5. Click the name of the virtual host to create a trace for.

    Figure 2 Virtual host to create a trace for

  6. In Permissions area, set the guest permission for the user.

    Virtual hosts must be configured the guest permission to enable tracing. Otherwise, an error is reported when a trace is created.
    Figure 3 Granting the guest permission for a virtual host

  7. In the navigation tree on the right, choose Tracing.

    Figure 4 Admin page

  8. In the Add a new trace area, set the following parameters and click Add trace to add a trace.

    Table 1 Trace parameters

    Parameter

    Description

    Virtual host

    Name of the virtual host.

    Name

    Name of the trace.

    Format

    Format of the output message log. Text (easy to read) and JSON (easy to parse) are supported.

    Tracer connection username

    Name of the user that creates tracing.

    Tracer connection password

    Password of the user that creates a trace.

    Max payload bytes

    Maximum size of a message, in bytes.

    Assume that Max payload bytes is set to 10. A message larger than 10 bytes will be truncated when it is transferred through RabbitMQ. For example, trace test payload will become trace test after truncation.

    Pattern

    Matching pattern. Options:

    • #: Trace all messages entering and leaving RabbitMQ.
    • publish#: Trace all messages entering RabbitMQ.
    • deliver#: Trace all messages leaving RabbitMQ.
    • publish.delay_exchange: Trace messages entering a specified exchange. delay_exchange indicates an exchange name. Change it to the actual value.
    • deliver.delay_queue: Trace messages entering a specified queue. delay_queue indicates a queue name. Change it to the actual value.
    Figure 5 Adding a trace

    After the trace is created, it is displayed in the All traces area.

    Figure 6 Trace list

  9. (Optional) For a cluster RabbitMQ instance, switch nodes by specifying Node and repeat 8 to create traces for them.

    Figure 7 Switching nodes

  10. After message logs are stored in the trace log file, click the trace log file name to view the log content.

    Figure 8 Trace log files

    Figure 9 shows the content of delay_exchange_trace.log.

    Figure 9 delay_exchange_trace.log

    Figure 10 shows the content of delay_queue_trace.log.

    Figure 10 delay_queue_trace.log

Stopping the Tracing Task and Disabling the Plug-in

  1. In the All traces area on the Tracing page, click Stop to stop the tracing task.

    Figure 11 Stopping a tracing task

  2. Go to the Plug-ins page on the RabbitMQ console, and click Disable next to rabbitmq_tracing. The Disable Plug-in dialog box is displayed.
  3. Click Yes. The Background Tasks page is displayed. If the task is in the Successful state, the rabbitmq_tracing plug-in is disabled.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback