The RabbitMQ integration collects message metrics, such as the number of delivered, published, and dropped messages. The integration also collects RabbitMQ logs and parses them into a JSON payload. The result includes process ID, level, and message.
For more information about RabbitMQ, see the RabbitMQ documentation.
PrerequisitesTo collect RabbitMQ telemetry, you must install the Ops Agent:
This integration supports RabbitMQ versions 3.8 and 3.9.
Configure your RabbitMQ instanceYou must enable the RabbitMQ management plugin by following the Getting started instructions.
You must configure a user with the monitoring tag.
Following the guide to Configure the Ops Agent, add the required elements to collect telemetry from RabbitMQ instances, and restart the agent.
Example configurationThe following commands create the configuration to collect and ingest telemetry for RabbitMQ:
For these changes to take effect, you must restart the Ops Agent:
Linuxsudo systemctl restart google-cloud-ops-agent
sudo systemctl status "google-cloud-ops-agent*"
Restart-Service google-cloud-ops-agent -Force
Get-Service google-cloud-ops-agent*
To ingest logs from RabbitMQ, you must create a receiver for the logs that RabbitMQ produces and then create a pipeline for the new receiver.
To configure a receiver for your rabbitmq logs, specify the following fields:
exclude_paths A list of filesystem path patterns to exclude from the set matched by include_paths. include_paths [var/log/rabbitmq/rabbit*.log] A list of filesystem paths to read by tailing each file. A wild card (*) can be used in the paths; for example, /var/log/rabbitmq/*.log. record_log_file_path false If set to true, then the path to the specific file from which the log record was obtained appears in the output log entry as the value of the agent.googleapis.com/log_file_path label. When using a wildcard, only the path of the file from which the record was obtained is recorded. type This value must be rabbitmq. wildcard_refresh_interval 60s The interval at which wildcard file paths in include_paths are refreshed. Given as a time duration, for example 30s or 2m. This property might be useful under high logging throughputs where log files are rotated faster than the default interval. What is logged
The logName is derived from the receiver IDs specified in the configuration. Detailed fields inside the LogEntry are as follows.
The rabbitmq logs contain the following fields in the LogEntry:
jsonPayload.message string Log message, including detailed stacktrace where provided jsonPayload.process_id string The process ID issuing the log jsonPayload.severity string Log entry level severity string (LogSeverity) Log entry level (translated). Configure metrics collection
To ingest metrics from RabbitMQ, you must create a receiver for the metrics that RabbitMQ produces and then create a pipeline for the new receiver.
This receiver does not support the use of multiple instances in the configuration, for example, to monitor multiple endpoints. All such instances write to the same time series, and Cloud Monitoring has no way to distinguish among them.
To configure a receiver for your rabbitmq metrics, specify the following fields:
ca_file Path to the CA certificate. As a client, this verifies the server certificate. If empty, the receiver uses the system root CA. cert_file Path to the TLS certificate to use for mTLS-required connections. collection_interval 60s A time duration value, such as 30s or 5m. endpoint http://localhost:15672 The URL of the node to monitor. insecure true Sets whether or not to use a secure TLS connection. If set to false, then TLS is enabled. insecure_skip_verify false Sets whether or not to skip verifying the certificate. If insecure is set to true, then the insecure_skip_verify value is not used. key_file Path to the TLS key to use for mTLS-required connections. password The password used to connect to the server. type This value must be rabbbitmq. username The username used to connect to the server. What is monitored
The following table provides the list of metrics that the Ops Agent collects from the RabbitMQ instance.
Metric type Kind, Typeworkload.googleapis.com/rabbitmq.consumer.count GAUGE, INT64
node_name
queue_name
vhost_name workload.googleapis.com/rabbitmq.message.current GAUGE, INT64
node_name
queue_name
state
vhost_name Verify the configuration
This section describes how to verify that you correctly configured the RabbitMQ receiver. It might take one or two minutes for the Ops Agent to begin collecting telemetry.
To verify that RabbitMQ logs are being sent to Cloud Logging, do the following:
In the Google Cloud console, go to the Logs Explorer page:
If you use the search bar to find this page, then select the result whose subheading is Logging.
resource.type="gce_instance"
log_id("rabbitmq")
To verify that RabbitMQ metrics are being sent to Cloud Monitoring, do the following:
In the Google Cloud console, go to the leaderboard Metrics explorer page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
{"workload.googleapis.com/rabbitmq.message.current", monitored_resource="gce_instance"}
To view your RabbitMQ metrics, you must have a chart or dashboard configured. The RabbitMQ integration includes one or more dashboards for you. Any dashboards are automatically installed after you configure the integration and the Ops Agent has begun collecting metric data.
You can also view static previews of dashboards without installing the integration.
To view an installed dashboard, do the following:
In the Google Cloud console, go to the Dashboards page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
If you have configured an integration but the dashboard has not been installed, then check that the Ops Agent is running. When there is no metric data for a chart in the dashboard, installation of the dashboard fails. After the Ops Agent begins collecting metrics, the dashboard is installed for you.
To view a static preview of the dashboard, do the following:
In the Google Cloud console, go to the Integrations page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
For more information about dashboards in Cloud Monitoring, see Dashboards and charts.
For more information about using the Integrations page, see Manage integrations.
Install alerting policiesAlerting policies instruct Cloud Monitoring to notify you when specified conditions occur. The RabbitMQ integration includes one or more alerting policies for you to use. You can view and install these alerting policies from the Integrations page in Monitoring.
To view the descriptions of available alerting policies and install them, do the following:
In the Google Cloud console, go to the Integrations page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
In the Configure notifications section, select one or more notification channels. You have the option to disable the use of notification channels, but if you do, then your alerting policies fire silently. You can check their status in Monitoring, but you receive no notifications.
For more information about notification channels, see Manage notification channels.
For more information about alerting policies in Cloud Monitoring, see Introduction to alerting.
For more information about using the Integrations page, see Manage integrations.
What's nextFor a walkthrough on how to use Ansible to install the Ops Agent, configure a third-party application, and install a sample dashboard, see the Install the Ops Agent to troubleshoot third-party applications video.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4