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 using Discovery and Service Mapping Patterns. This functionality is available starting with the Australia release and requires the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.
Show less
Key Features
- Pattern Activation: The Amazon MQ Broker discovery pattern is disabled by default and must be enabled. Starting from Visibility Content version 6.28.0, enabling or disabling patterns is no longer treated as a customization, ensuring seamless updates.
- AWS Discovery Prerequisites: Customers must verify AWS discovery prerequisites and ensure relevant resources are not listed in the Resource Inclusion List to prevent duplicate discoveries.
- GovCloud Support: Discovery in AWS GovCloud (US) requires using a datacenter URL when configuring AWS service accounts.
- Data Population: The pattern populates data in both CMDB tables (for configuration items) and non-CMDB tables (for extended inventory data), ensuring comprehensive visibility of Amazon MQ Brokers.
- Tag Collection: Tags associated with Amazon MQ Brokers are collected and stored in the Key Value table, linked to the Cloud Messaging Service CI for enhanced metadata management.
Data and Configuration Details
The discovery populates the following key tables:
- Non-CMDB Table (
cmdbawsmqbroker): Stores broker-specific details such as name, ARN (object ID), broker ID, state (e.g., RUNNING, CREATIONINPROGRESS), engine type and version (e.g., ACTIVEMQ, RABBITMQ), and host instance type. It also references the Cloud Messaging Service CI. - CMDB Table (
cmdbcicloudmessagingservice): Contains the broker as a configuration item with fields including name, ARN, resource type (AWS::MQ::Broker), install status (default Installed), and operational status (default Operational). - Key Value Table (
cmdbkeyvalue): Stores AWS tags as key-value pairs linked to the Cloud Messaging Service CI, facilitating tag-based management and filtering.
CI Relationships and References
- Relationships: The pattern establishes a "Hosted on::Hosts" relationship linking the Cloud Messaging Service CI to the AWS Datacenter CI, supporting accurate infrastructure mapping.
- References: The AWS MQ Broker record references its related Cloud Messaging Service CI, and the Key Value table entries reference the Cloud Messaging Service CI as well, maintaining consistent linkage across tables.
Practical Considerations
- Ensure the AWS discovery prerequisites are met and remove any Amazon MQ Broker resources from the Resource Inclusion List to avoid duplicate entries.
- Enable the Amazon MQ Broker discovery pattern as it is disabled by default.
- Configure discovery schedules appropriately, especially when targeting AWS GovCloud environments.
- Review the populated data in both CMDB and non-CMDB tables to gain comprehensive insights into your Amazon MQ Broker resources and their relationships.
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. |