AWS X-Ray Sampling Rule pattern-based discovery

  • Release version: Australia
  • 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 detect and map AWS X-Ray Sampling Rules within their cloud environments. This functionality is part of the Discovery and Service Mapping Patterns application and helps populate accurate AWS X-Ray sampling rule data into both Configuration Management Database (CMDB) and non-CMDB tables. It supports enhanced visibility and management of AWS X-Ray sampling configurations.

    Show full answer Show less

    Key Features

    • Pattern Activation: The AWS X-Ray Sampling Rule pattern is disabled by default. Customers must enable it to start discovery. Activation and deactivation of patterns no longer count as customizations starting with Visibility Content version 6.28.0, ensuring smooth updates.
    • Prerequisites: AWS discovery prerequisites must be met, and resources should not be duplicated in the Resource Inclusion List [sacloudinventoryresourcewhitelist] table to avoid repeated discovery.
    • Data Population: The discovery populates detailed AWS X-Ray Sampling Rule data in the cmdbawsxraysamplingrule table, capturing attributes such as rule name, ARN, priority, service name/type, and version.
    • Cloud Resource Mapping: Corresponding cloud resources are stored in cmdbcicmpresource with resource type set to AWS::XRay::SamplingRule, including operational and install status.
    • CI Relationships and References: Relationships are created between sampling rules and AWS datacenters, and references link to configuration items and key-value tag records to maintain data integrity and traceability.
    • Tag Discovery: AWS tags associated with sampling rules are collected and stored in the cmdbkeyvalue table, allowing tagging metadata to be leveraged within the CMDB.

    Practical Benefits

    • Provides automated and consistent discovery of AWS X-Ray Sampling Rules, reducing manual entry and errors.
    • Ensures up-to-date mapping of AWS sampling configurations in the CMDB for improved visibility and impact analysis.
    • Supports compliance and operational monitoring by tracking sampling rule priorities, versions, and associated services.
    • Facilitates cloud resource management and service mapping by linking sampling rules to AWS datacenters and tagging metadata.

    Implementation Considerations

    • Update to the latest Discovery and Service Mapping Patterns application version from the ServiceNow Store to access this pattern.
    • Verify and clear relevant entries from the Resource Inclusion List to prevent duplicate discoveries.
    • Enable the AWS X-Ray Sampling Rule pattern to initiate discovery and data population.
    • Review discovered data in both CMDB and non-CMDB AWS tables for comprehensive insight.

    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.