Skip to main content
Sumo Logic

Install the ActiveMQ Monitors, App, and view the Dashboards

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

Pre-Packaged Alerts

Sumo Logic has provided out of the box alerts available through Sumo Logic monitors to help you monitor your ActiveMQ clusters. These alerts are built based on metrics and logs datasets and include preset thresholds based on industry best practices and recommendations.

For details on the individual alerts,  please see this page.

Installing Monitors

  • To install these alerts, you need to have the Manage Monitors role capability.
  • Alerts can be installed by either importing a JSON file or a Terraform script.
  • Note: There are limits to how many alerts can be enabled - please see the Alerts FAQ for details.
Method 1: Install the 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 ActiveMQ 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_system=activemq with <Your Custom Filter>.  

Custom filter examples: 

  1. For alerts applicable only to a specific cluster, your custom filter would be:  ‘messaging_cluster=activemq-prod.01‘
  2. For alerts applicable to all clusters that start with activemq-prod, your custom filter would be: messaging_cluster=activemq-prod*
  3. For alerts applicable to a specific cluster within a production environment, your custom filter would be: messaging_cluster=activemq-1 and environment=prod (This assumes you have set the optional environment tag while configuring collection)
  4. Go to Manage Data > Alerts > Monitors.
  5. Click Add:
    Add monitors page.png
  6. Click Import and then copy-paste the above JSON to import monitors.
Method 2: Install the alerts using a Terraform script
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 in Sumo Logic using these instructions. Please identify which deployment your Sumo Logic account is in, using this  link.

3. Download the Sumo Logic Terraform package for ActiveMQ alerts

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

4. Alert Configuration 

After the package has been extracted, navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/ActiveMQ/

Edit the activemq.auto.tfvars file and add the Sumo Logic Access Key, Access Id, and Deployment from Step 1.

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 variable ’activemq_data_source’. Custom filter examples: 

  1. A specific cluster messaging_cluster=activemq.prod.01
  2. All clusters in an environment environment=prod
  3. For alerts applicable to all clusters that start with activemq-prod, your custom filter would be: ‘messaging_cluster=activemq-prod*’
  4. For alerts applicable to a specific cluster within a production environment, your custom filter would be:activemq_cluster=activemq-1 and environment=prod (This assumes you have set the optional environment tag while configuring collection)

All monitors are disabled by default on installation, if you would like to enable all the monitors, set the parameter monitors_disabled to false in this file.

By default, the monitors are configured in a monitor folder called “ActiveMQ”, if you would like to change the name of the folder, update the monitor folder name in “folder” key at activemq.auto.tfvars file.

If you would like the alerts to send email or connection notifications, configure these in the file activemq_notifications.auto.tfvars. For configuration examples, refer to the next section.

5. Email and Connection Notification Configuration Examples

Modify the file activemq_notifications.auto.tfvars and populate connection_notifications and email_notifications as per below examples.

Pagerduty Connection Example:
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"]
    }
  ]

Replace <CONNECTION_ID> with the connection id of the webhook connection. The webhook connection id can be retrieved by calling the Monitors API.

For overriding payload for different connection types, refer to this document.

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"]
    }
  ]
6. Install the Alerts
  1. Navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/ActiveMQ/ and run terraform init. This will initialize Terraform and will download the required components.
  2. Run terraform plan to view the monitors which will be created/modified by Terraform.
  3. Run terraform apply.

7. Post Installation

If you haven’t enabled alerts and/or configured notifications through the Terraform procedure outlined above, we highly recommend enabling alerts of interest and configuring each enabled alert to send notifications to other users or services. This is detailed in Step 4 of this document.

NoteThere are limits to how many alerts can be enabled - please see the Alerts FAQ.

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 ActiveMQ cluster filter. Examples: 

    1. For all ActiveMQ  clusters
      messaging_cluster=*

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


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

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

    5. Click Add to Library.

Once an app is installed, it will appear in your Personal folder, or another 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.

ActiveMQ - Overview

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

Use this dashboard to:

  • Analyze Memory and CPU utilization.
  • Gain insights into Enqueue messages for your ActiveMQ server.
  • Gain insights into Dequeue messages for your ActiveMQ server.
  • Determine node uptime, the number of nodes, connections, producer, consumer, queues, topics unack messages, across each cluster and ensure they match with expectations.
  • Analysis of near errors.

ActiveMQ - Brokers

The ActiveMQ - Brokers dashboard provides an at-a-glance view of the state of your brokers in the ActiveMQ cluster.

Use this dashboard to:

  • Monitor brokers uptime.
  • Analyze unacknowledged messages, serve connections for your ActiveMQ brokers..
  • Gain insights into the limit of resources for your ActiveMQ brokers.
  • Gain insights into enqueue rate, dequeue rate for your ActiveMQ brokers.
  • Determine the amount of current connections, producers, and consumers for your ActiveMQ brokers.
  • find average message size.

ActiveMQ - Queues

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

Use this dashboard to:

  • Monitor en queue latency, the memory usage of queues.
  • Monitor queues, producers on queues, consumers on queues.
  • Gain insights into en queue rate, dequeue rate for your ActiveMQ queues.
  • Determine the number of current connections, producers, consumers, errors, and expired messages on queues.
  • Find average message size on queues.

ActiveMQ - Topics

The ActiveMQ - Topics dashboard provides an at-a-glance view of the state of your topics in ActiveMQ clusters. 

Use this dashboard to:

  • Monitor en queue latency, the memory usage of topics.
  • Determine the number of topics, producers on topics, consumers on topics.
  • Gain insights into en queue rate, dequeue rate for your ActiveMQ topics.
  • Analyze current connections, producers, consumers, errors, and expired messages on queues.
  • Find average message size on queues.

ActiveMQ - Resource Utilization

The ActiveMQ - Resource Utilization dashboard provides an at-a-glance view of the state of system loads in clusters: CPU usage, memory usage, Swap usage,  file descriptor usage, garbage collection rate, heap, and non-heap usage.

Use this dashboard to:

  • Analyze memory, CPU, disk, swap, file descriptor utilization of nodes in clusters.
  • Gain insights into the garbage collection rate for your ActiveMQ nodes.
  • Gain insights into a heap, non-heap usage for your ActiveMQ nodes.

ActiveMQ - Logs

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

Use this dashboard to:

  • Identify critical events in your ActiveMQ 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 ActiveMQ cluster.