Amazon MQ Broker pattern-based discovery
Summarize
Summary of Amazon MQ Broker pattern-based discovery
The Amazon MQ Broker pattern-based discovery enables ServiceNow customers to identify and map Amazon MQ Brokers within their AWS cloud environments. This functionality is part of the Discovery and Service Mapping Patterns application, which requires the latest version from the ServiceNow Store for full compatibility and feature support. The discovery process populates configuration management database (CMDB) and non-CMDB tables with broker details, supporting effective cloud resource management.
Show less
Key Features
- Pattern Activation: The Amazon MQ Broker discovery pattern is disabled by default. Since Visibility Content version 6.28.0, activating or deactivating patterns does not count as a customization, ensuring updates continue seamlessly after upgrades.
- Prerequisites and Configuration: Customers must verify AWS discovery prerequisites, remove relevant resources from the Resource Inclusion List to avoid duplicate discovery, and configure discovery schedules correctly, especially for AWS GovCloud accounts that require a datacenter URL.
- Data Population: The discovery populates both CMDB and non-CMDB tables:
- Non-CMDB Table [cmdbawsmqbroker]: Stores broker-specific details such as name, Amazon Resource Name (ARN), broker ID, broker state (e.g., RUNNING, CREATIONINPROGRESS), engine type and version, host instance type, and a reference to the Cloud Messaging Service CI.
- CMDB Table [cmdbcicloudmessagingservice]: Contains key broker information including name, ARN, resource type (fixed as AWS::MQ::Broker), install status (default Installed), and operational status (default Operational).
- CI Relationships and References: The pattern creates CI relationships such as "Hosted on" between Cloud Messaging Service and AWS Datacenter CIs, and maintains references between AWS MQ Broker and Cloud Messaging Service records, facilitating comprehensive service mapping.
- AWS Tag Collection: Tags associated with brokers are discovered and stored in the Key Value [cmdbkeyvalue] table, linking tag names and values to the corresponding Cloud Messaging Service CI.
Practical Implications for ServiceNow Customers
By implementing the Amazon MQ Broker discovery pattern, customers gain accurate visibility into their Amazon MQ Broker instances within AWS. This supports enhanced configuration management, operational monitoring, and service mapping, enabling better control and troubleshooting of messaging infrastructure. Proper configuration of discovery schedules and resource lists ensures efficient and non-duplicative data collection. Additionally, capturing tags enriches the CMDB with metadata useful for governance and reporting.
Discovery and Service Mapping Patterns finds Amazon MQ Brokers on your cloud environment. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.
Pattern-based discovery and mapping requirements
- Verify the AWS discovery prerequisites
- For more information, see the prerequisites section in AWS discovery using patterns.
- Remove resources from the Resource Inclusion List table
- Verify that the relevant resource isn't listed in the Resource Inclusion List [sa_cloud_inventory_resource_whitelist] table to avoid duplicate discovery. For more information on removing resources from the Resource Inclusion List, see AWS Resource Inventory discovery with Patterns.
- Enable the relevant pattern
- The pattern for this service is disabled by default. Starting with Visibility Content version 6.28.0, activating or deactivating a pattern won't be considered a customization, and it will continue to receive updates. Patterns that were previously activated or deactivated will reset to the latest predefined version after upgrading while retaining the last active field value. For more information on enabling patterns, see Activate a disabled pattern.
- Configure the Discovery schedule to support GovCloud
- Discovering AWS GovCloud (US) accounts requires using a datacenter URL when setting up an AWS service account. For more information, see Create AWS service accounts.
Discovery and Service Mapping Patterns application populates data in both CMDB and non-CMDB tables.
Data stored in non-CMDB tables
Discovery and Service Mapping Patterns application populates data in the non-CMDB table when running the Amazon AWS - MQ Broker - Extended Inventory (LP) pattern.
You can review the non-CMDB AWS tables by navigating to . You can also search the navigation filter for the specific pattern name.
| Field | Description |
|---|---|
| Name [name] | Name of the broker. |
| Object ID [object_id] | The Amazon Resource Name (ARN) of the broker. |
| Broker Id [broker_id] | The unique ID of the broker. |
| Broker State [broker_state] | The current state of the broker. For example: RUNNING, CREATION_IN_PROGRESS, DELETION_IN_PROGRESS, or REBOOT_IN_PROGRESS. |
| Engine Type [engine_type] | The type of broker engine. For example: ACTIVEMQ or RABBITMQ. |
| Engine Version [engine_version] | The version of the broker engine. |
| Host Instance Type [host_instance_type] | The broker's instance type, which determines the computing resources assigned to the broker. |
| Configuration Item [configuration_item] | References the Cloud Messaging Service [cmdb_ci_cloud_messaging_service] table. |
Data stored in CMDB tables
Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - MQ Broker - Extended Inventory (LP) pattern.
| Field | Description |
|---|---|
| Name [name] | Name of the broker. |
| Object ID [object_id] | The ARN of the broker. |
| Type [type] | Type of resource. The value is set to AWS::MQ::Broker. |
| Install Status [install_status] | Install status of the resource. Default value is Installed. |
| Operational status [operational_status] | Operational status of the resource. Default value is Operational. |
CI relationships
The Amazon AWS - MQ Broker - Extended Inventory (LP) pattern creates the following relationships and references to support Amazon MQ Broker discovery. References link to records in other tables and don't appear in the CI Relationship [cmdb_rel_ci] table.
| CI | Relationship | CI |
|---|---|---|
| Cloud Messaging Service [cmdb_ci_cloud_messaging_service] | Hosted on::Hosts | AWS Datacenter [cmdb_ci_aws_datacenter] |
| CI | Field | Referenced CI |
|---|---|---|
| AWS MQ Broker [cmdb_aws_mq_broker] | Configuration Item [configuration_item] | Cloud Messaging Service [cmdb_ci_cloud_messaging_service] |
| Key Value [cmdb_key_value] | Configuration item [configuration_item] | Cloud Messaging Service [cmdb_ci_cloud_messaging_service] |
AWS Tag discovery
The Amazon AWS - MQ Broker - Extended Inventory (LP) pattern collects tags and populates them in the Key Value [cmdb_key_value] table.
| Field | Description |
|---|---|
| Key [key] | Tag name. |
| Value [value] | Tag value. |
| Configuration item [configuration_item] | References the Cloud Messaging Service [cmdb_ci_cloud_messaging_service] table. |