AWS X-Ray Sampling Rule pattern-based discovery

  • Release version: Zurich
  • Updated May 13, 2026
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of AWS X-Ray Sampling Rule pattern-based discovery

    The AWS X-Ray Sampling Rule pattern-based discovery enables ServiceNow customers to automatically discover and map AWS X-Ray Sampling Rules within their cloud environments using the Discovery and Service Mapping Patterns application. This facilitates comprehensive visibility and management of AWS X-Ray Sampling Rules as part of the Configuration Management Database (CMDB) and non-CMDB data tables.

    Show full answer Show less

    Prerequisites and Setup

    • Ensure AWS discovery prerequisites are met as detailed in the AWS discovery documentation.
    • Remove any relevant resources from the Resource Inclusion List table (sacloudinventoryresourcewhitelist) to avoid duplicate discovery.
    • Enable the AWS X-Ray Sampling Rule pattern, which is disabled by default. Starting with Visibility Content version 6.28.0, pattern activation or deactivation is no longer considered a customization and will retain settings through upgrades.

    Data Storage and Tables

    The discovery populates data in both CMDB and non-CMDB tables:

    • Non-CMDB data: Collected by the Amazon AWS - XRay Sampling Rule - Extended Inventory (LP) pattern and stored under AWS-specific tables accessible via the Configuration > AWS section.
    • CMDB data: Sampling rules are recorded as Cloud Resource [cmdbcicmpresource] CIs with resource type AWS::XRay::SamplingRule. Key fields include name, ARN, install status, and operational status.

    Key Fields and Relationships

    • AWS XRay Sampling Rule Table [cmdbawsxraysamplingrule]: Captures sampling rule name, ARN, priority (lower value means higher priority), associated resource and service ARNs, service type, and version.
    • Cloud Resource Table [cmdbcicmpresource]: Stores the sampling rule as a CI with install and operational status.
    • CI Relationships: The pattern creates a relationship indicating the sampling rule is hosted on an AWS Datacenter, supporting accurate service mapping.
    • CI References: Sampling rules reference the related Cloud Resource and Key Value (tag) records but these references do not appear in the CI Relationship table.

    AWS Tag Collection

    The pattern collects AWS tags associated with each sampling rule and populates them into the Key Value [cmdbkeyvalue] table. Each tag record includes the tag name, tag value, and a reference to its associated Cloud Resource CI.

    Benefits for ServiceNow Customers

    • Automated discovery and accurate mapping of AWS X-Ray Sampling Rules enhance cloud visibility and CMDB accuracy.
    • Integration with existing ServiceNow CMDB enables efficient resource tracking and impact analysis.
    • Tag collection supports better resource categorization and governance.
    • Pattern-based discovery ensures up-to-date data reflecting changes in the AWS environment.

    Discovery and Service Mapping Patterns finds AWS X-Ray Sampling Rules 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.

    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 - XRay Sampling Rule - Extended Inventory (LP) pattern.

    You can review the non-CMDB AWS tables by navigating to All > Configuration > AWS. You can also search the navigation filter for the specific pattern name.

    Table 1. AWS XRay Sampling Rule [cmdb_aws_xray_sampling_rule]
    Field Description
    Name [name] Name of the sampling rule.
    Object ID [object_id] The Amazon Resource Name (ARN) of the sampling rule.
    Priority [priority] The priority of the sampling rule. Lower values indicate higher priority.
    Resource ARN [resource_arn] The ARN of the resource to which the sampling rule applies. An asterisk (*) matches all resources.
    Service Name [service_name] The name of the service to which the sampling rule applies. An asterisk (*) matches all services.
    Service Type [service_type] The type of the service to which the sampling rule applies.
    Version [version] The version number of the sampling rule.
    Configuration Item [configuration_item] References the Cloud Resource [cmdb_ci_cmp_resource] table.

    Data stored in CMDB tables

    Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - XRay Sampling Rule - Extended Inventory (LP) pattern.

    Table 2. Cloud Resource [cmdb_ci_cmp_resource]
    Field Description
    Name [name] Name of the sampling rule.
    Object ID [object_id] The ARN of the sampling rule.
    Resource type [resource_type] Type of resource. The value is set to AWS::XRay::SamplingRule.
    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 - XRay Sampling Rule - Extended Inventory (LP) pattern creates the following relationships and references to support AWS X-Ray Sampling Rule discovery. References link to records in other tables and don't appear in the CI Relationship [cmdb_rel_ci] table.

    Table 3. CI relationships
    CI Relationship CI
    Cloud Resource [cmdb_ci_cmp_resource] Hosted on::Hosts AWS Datacenter [cmdb_ci_aws_datacenter]
    Table 4. CI references
    CI Field Referenced CI
    AWS XRay Sampling Rule [cmdb_aws_xray_sampling_rule] Configuration Item [configuration_item] Cloud Resource [cmdb_ci_cmp_resource]
    Key Value [cmdb_key_value] Configuration item [configuration_item] Cloud Resource [cmdb_ci_cmp_resource]

    AWS Tag discovery

    The Amazon AWS - XRay Sampling Rule - Extended Inventory (LP) pattern collects tags and populates them in the Key Value [cmdb_key_value] table.

    Table 5. Key Value [cmdb_key_value]
    Field Description
    Key [key] Tag name.
    Value [value] Tag value.
    Configuration item [configuration_item] References the Cloud Resource [cmdb_ci_cmp_resource] table.