AWS X-Ray Sampling Rule pattern-based discovery

  • Release version: Yokohama
  • 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 detect and map AWS X-Ray Sampling Rules within their cloud environment using the Discovery and Service Mapping Patterns application. This capability helps organizations maintain an accurate and up-to-date inventory of their AWS X-Ray Sampling Rules and related resources in their Configuration Management Database (CMDB) and non-CMDB tables.

    Show full answer Show less

    Prerequisites and Setup

    • AWS discovery prerequisites: Customers must verify and meet AWS discovery prerequisites detailed in the Amazon AWS Cloud components discovery documentation.
    • Resource Inclusion List: Ensure the relevant sampling rule resources are not listed in the Resource Inclusion List [sacloudinventoryresourcewhitelist] to avoid duplicate discovery.
    • Pattern activation: The AWS X-Ray Sampling Rule pattern is disabled by default and must be enabled. With Visibility Content version 6.28.0 and later, enabling or disabling patterns is treated as a standard update, ensuring ongoing support and updates.

    Data Collection and Storage

    The discovery populates data in both CMDB and non-CMDB tables, supporting comprehensive visibility and management of AWS X-Ray Sampling Rules.

    Non-CMDB Data

    • Discovered data is stored using the Amazon AWS - XRay Sampling Rule - Extended Inventory (LP) pattern.
    • Non-CMDB AWS tables can be reviewed in ServiceNow under All > Configuration > AWS or by searching the pattern name.
    • The AWS XRay Sampling Rule [cmdbawsxraysamplingrule] table includes key fields such as sampling rule name, ARN, priority, resource ARN, service name and type, version, and references to the Cloud Resource table.

    CMDB Data

    • The pattern also populates the Cloud Resource [cmdbcicmpresource] table with details about the sampling rule as an AWS resource.
    • Key fields include resource name, ARN, resource type set to AWS::XRay::SamplingRule, install status, and operational status.

    Configuration Item (CI) Relationships and References

    • The discovery creates CI relationships such as Hosted on::Hosts linking the Cloud Resource to the AWS Datacenter.
    • References between the AWS XRay Sampling Rule and Cloud Resource tables establish data connections without creating entries in the CI Relationship table.

    AWS Tag Discovery

    • The pattern collects AWS tags associated with sampling rules and stores them in the Key Value [cmdbkeyvalue] table.
    • This includes tag names, values, and references back to the Cloud Resource records, facilitating tag-based management and reporting.

    Benefits for ServiceNow Customers

    This discovery pattern allows customers to automatically identify and manage AWS X-Ray Sampling Rules within their CMDB, maintain resource relationships, and leverage tagging information. It supports operational oversight, enhances service mapping accuracy, and integrates AWS resource data seamlessly into ServiceNow’s Configuration Management processes.

    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 Amazon AWS Cloud components 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 Amazon Web Services (AWS) Resource Inventory.
    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.