Skip to main content
Sumo Logic

Install the RabbitMQ Monitors, the App, and view the Dashboards

This page provides instructions for installing the Sumo App, and monitors for RabbitMQ, as well as the descriptions of each of the app dashboards.

This page has instructions for installing Sumo Logic Monitors for RabbitMQ, the app and descriptions of each of the app dashboards. These instructions assume you have already set up collection as described in the Collect Logs and Metrics for RabbitMQ page.

Install Monitors

Sumo Logic has provided pre-packaged alerts available through Sumo Logic monitors to help you proactively determine if a RabbitMQ cluster is available and performing as expected. These monitors are based on metric and log data and include pre-set thresholds that reflect industry best practices and recommendations. For more information about individual alerts, see RabbitMQ Alerts.

To install these monitors, you must have the Manage Monitors role capability.

You can install monitors by importing a JSON file or using a Terraform script.

Method 1: Install Monitors by importing a JSON file

  1. Download the JSON file that describes the monitors. 

  2. The JSON contains the alerts that are based on Sumo Logic searches that do not have any scope filters and therefore will be applicable to all RabbitMQ clusters, the data for which has been collected via the instructions in the previous sections.  

However, if you would like to restrict these alerts to specific clusters or environments, update the JSON file by replacing the text messaging_cluster=* with <Your Custom Filter>.  

Custom filter examples: 

  1. For alerts applicable only to a specific cluster, your custom filter would be:  messaging_cluster=dev-rabbitmq01

  2. For alerts applicable to all clusters that start with RabbitMQ-prod, your custom filter would be: messaging_cluster=RabbitMQ-prod*

  3. For alerts applicable to a specific cluster within a production environment, your custom filter would be: 

messaging_cluster=dev-rabbitmq01 AND environment=prod (This assumes you have set the optional environment tag while configuring collection)

  1. Go to Manage Data > Alerts > Monitors.

  2. Click Add.

  3. Click Import.
    import-option.png

  4. On the Import Content popup, enter RabbitMQ in the Name field, paste in the JSON into the the popup, and click Import.
    import-content.png

  5. The monitors are created in a "RabbitMQ" folder. The monitors are disabled by default. See the Monitors topic for information about enabling monitors and configuring notifications or connections.

Method 2: Install Monitors using a Terraform script

Step 1: Generate a Sumo Logic access key and ID

Generate an access key and access ID for a user that has the Manage Monitors role capability. For instructions see  Access Keys

Step 2: Download and install Terraform

Download Terraform 0.13 or later, and install it. 

Step 3: Download the Sumo Logic Terraform package for MySQL monitors

The alerts package is available in the Sumo Logic github repository. You can either download it using the git clone command or as a zip file. 

Step 4: Alert Configuration 

After extracting the package , navigate to the  terraform-sumologic-sumo-logic-monitor/monitor_packages/RabbitMQ/ directory.

Edit the rabbitmq.auto.tfvars file and add the Sumo Logic Access Key and Access ID from Step 1 and your Sumo Logic deployment. If you're not sure of your deployment, see Sumo Logic Endpoints and Firewall Security

access_id   = "<SUMOLOGIC ACCESS ID>"

access_key  = "<SUMOLOGIC ACCESS KEY>"

environment = "<SUMOLOGIC DEPLOYMENT>"

The Terraform script installs the alerts without any scope filters, if you would like to restrict the alerts to specific clusters or environments, update the rabbitmq_data_source variable. For example:

To configure alerts for...

Set rabbitmq_data_source to something like :

A specific cluster

messaging_cluster=rabbitmq.prod.01

All clusters in an environment

environment=prod

Multiple clusters using a wildcard

messaging_cluster=rabbitmq-prod*

A specific cluster within a specific environment

messaging_cluster=rabbitmq-1 and environment=prod

 

This assumes you have configured and applied Fields as described in Step 1: Configure Fields of the Sumo Logic of the Collect Logs and Metrics for RabbitMQ topic.

All monitors are disabled by default on installation. To enable all of the monitors, set the monitors_disabled parameter to false.

By default, the monitors will be located in a "RabbitMQ" folder on the Monitors page. To change the name of the folder, update the monitor folder name in the folder variable in the rabbitmq.auto.tfvars file.

If you want the alerts to send email or connection notifications, follow the instructions in the next section.

Step 5: Email and Connection Notification Configuration Examples

Edit the rabbitmq_notifications.auto.tfvars file to populate the connection_notifications and email_notifications sections. Examples are provided below.

Pagerduty connection example

In the variable definition below, replace <CONNECTION_ID> with the connection ID of the Webhook connection. You can obtain the Webhook connection ID by calling the Monitors API.

connection_notifications = [
    {
      connection_type       = "PagerDuty",
      connection_id         = "<CONNECTION_ID>",
      payload_override      = "{\"service_key\": \"your_pagerduty_api_integration_key\",\"event_type\": \"trigger\",\"description\": \"Alert: Triggered {{TriggerType}} for Monitor {{Name}}\",\"client\": \"Sumo Logic\",\"client_url\": \"{{QueryUrl}}\"}",
      run_for_trigger_types = ["Critical", "ResolvedCritical"]
    },
    {
      connection_type       = "Webhook",
      connection_id         = "<CONNECTION_ID>",
      payload_override      = "",
      run_for_trigger_types = ["Critical", "ResolvedCritical"]
    }
  ]
Email notifications example
email_notifications = [
    {
      connection_type       = "Email",
      recipients            = ["abc@example.com"],
      subject               = "Monitor Alert: {{TriggerType}} on {{Name}}",
      time_zone             = "PST",
      message_body          = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}",
      run_for_trigger_types = ["Critical", "ResolvedCritical"]
    }
  ]

Step 6: Install Monitors

  1. Navigate to the terraform-sumologic-sumo-logic-monitor/monitor_packages/rabbitmq/ directory and run terraform init. This will initialize Terraform and download the required components.

  2. Run terraform plan to view the monitors that Terraform will create or modify.

  3. Run terraform apply.

This section demonstrates how to install the RabbitMQ App.

To install the app:

Locate and install the app you need from the App Catalog. If you want to see a preview of the dashboards included with the app before installing, click Preview Dashboards.

  1. From the App Catalog, search for and select the app. 

  2. Select the version of the service you're using and click Add to Library.

  1. To install the app, complete the following fields.

    1. App Name. You can retain the existing name, or enter a name of your choice for the app.


    2. Data Source. 

      • Choose Enter a Custom Data Filter, and enter a custom RabbitMQ cluster filter. Examples: 

        1. For all RabbitMQ  clusters
          messaging_cluster=*

        2. For a specific cluster:
          messaging_cluster=rabbitmq.dev.01.


        3. Clusters within a specific environment:
          messaging_cluster=rabbitmq-1 and environment=prod
          (This assumes you have set the optional environment tag while configuring collection)

    3. Advanced. Select the Location in Library (the default is the Personal folder in the library), or click New Folder to add a new folder.

    4. Click Add to Library.

Once an app is installed, it will appear in your Personal folder, or other folder that you specified. From here, you can share it with your organization. 

Panels will start to fill automatically. It's important to note that each panel slowly fills with data matching the time range query and received since the panel was created. Results won't immediately be available, but with a bit of time, you'll see full graphs and maps.

Dashboard Filters with Template Variables

Template variables provide dynamic dashboards that rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you can view dynamic changes to the data for a fast resolution to the root cause. For more information, see the Filter with template variables help page.

RabbitMQ - Overview

The RabbitMQ - Overview dashboard gives you an at-a-glance view of your RabbitMQ deployment across brokers, queues, exchanges, and messages. 

Use this dashboard to :

  • Analyze Memory and disk utilization.
  • Gain insights into pushing messages for your RabbitMQ server.
  • Gain insights into delivery messages for your RabbitMQ server.
  • Determine the number of nodes, connections, exchanges, consume, queues, unack messages, total messages, across each cluster and ensure they match with expectations
  • Analysis of near errors.

RabbitMQ - Node

The RabbitMQ - Node dashboard helps you Get an at-a-glance view of the state of the nodes in the RabbitMQ cluster.

Use this dashboard to:

  • Monitor the number of open file descriptors.
  • Monitor uptime of nodes.
  • Determine the amount of ram transaction, disk transaction.
  • Determine the amount of  garbage collection per second.
  • Monitor current memory usage

 

RabbitMQ - Queue

The RabbitMQ - Queue dashboard provides an at-a-glance view of the state of your queues in your RabbitMQ clusters.

Use this dashboard to:

  • Monitor number of consumers on queues
  • Gain insights into pushing messages rate for queues of your RabbitMQ cluster.
  • Gain insights into delivery messages rate for queues of your RabbitMQ cluster.
  • Determine the amount of slave nodes for queues.
  • Monitor memory usage of queues over time.
  • Determine the number of error messages on queues.

 

RabbitMQ - Exchanges

The RabbitMQ - Exchanges dashboard provides an at-a-glance view of the state of your exchanges in your RabbitMQ clusters.

Use this dashboard to:

  • Monitor number of total messages published in exchanges
  • Monitor number of total messages published out exchanges
  • Gain insights into message publish Rate in exchanges of your RabbitMQ cluster.
  • Gain insights into message publish Rate out exchanges of your RabbitMQ cluster.

RabbitMQ - Logs

This dashboard helps you quickly analyze your RabbitMQ error logs across all clusters.

Use this dashboard to:

  • Identify critical events in your RabbitMQ cluster.
  • Examine trends to detect spikes in Error or Fatal events
  • Monitor Broker added/started and shutdown events in your cluster.
  • Quickly determine patterns across all logs in a given RabbitMQ cluster.