Skip to content
AWS for Query.Farm

aws.xray.get_service_graph

Example SQL Queries

SELECT * FROM
aws.xray.get_service_graph
WHERE
"start_time" = 'VALUE'
AND "end_time" = 'VALUE';

Description

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.

Table Definition

Column NameColumn Data Type
end_time Required Input Column

The end of the time frame for which the graph was generated.

TIMESTAMP_S
start_time Required Input Column

The start of the time frame for which the graph was generated.

TIMESTAMP_S
group_arn Input Column

The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.

VARCHAR
group_name Input Column

The name of a group based on which you want to generate a graph.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
contains_old_group_versions

A flag indicating whether the group's filter expression has been consistent, or if the returned service graph may show traces from an older version of the group's filter expression.

BOOLEAN
services

The services that have processed a traced request during the specified time frame.

STRUCT(
    "reference_id" BIGINT,
    "name" VARCHAR,
    "names" VARCHAR[],
    "root" BOOLEAN,
    "account_id" VARCHAR,
    "type" VARCHAR,
    "state" VARCHAR,
    "start_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S,
    "edges" STRUCT(
        "reference_id" BIGINT,
        "start_time" TIMESTAMP_S,
        "end_time" TIMESTAMP_S,
        "summary_statistics" STRUCT(
            "ok_count" BIGINT,
            "error_statistics" STRUCT(
                "throttle_count" BIGINT,
                "other_count" BIGINT,
                "total_count" BIGINT
            ),
            "fault_statistics" STRUCT(
                "other_count" BIGINT,
                "total_count" BIGINT
            ),
            "total_count" BIGINT,
            "total_response_time" DOUBLE
        ),
        "response_time_histogram" STRUCT(
            "value" DOUBLE,
            "count" BIGINT
        )[],
        "aliases" STRUCT(
            "name" VARCHAR,
            "names" VARCHAR[],
            "type" VARCHAR
        )[],
        "edge_type" VARCHAR,
        "received_event_age_histogram" STRUCT(
            "value" DOUBLE,
            "count" BIGINT
        )[]
    )[],
    "summary_statistics" STRUCT(
        "ok_count" BIGINT,
        "error_statistics" STRUCT(
            "throttle_count" BIGINT,
            "other_count" BIGINT,
            "total_count" BIGINT
        ),
        "fault_statistics" STRUCT(
            "other_count" BIGINT,
            "total_count" BIGINT
        ),
        "total_count" BIGINT,
        "total_response_time" DOUBLE
    ),
    "duration_histogram" STRUCT(
        "value" DOUBLE,
        "count" BIGINT
    )[],
    "response_time_histogram" STRUCT(
        "value" DOUBLE,
        "count" BIGINT
    )[]
)[]
Show child fields
services[]
Show child fields
services[].account_id

Identifier of the Amazon Web Services account in which the service runs.

services[].duration_histogram[]
Show child fields
services[].duration_histogram[].count

The prevalence of the entry.

services[].duration_histogram[].value

The value of the entry.

services[].edges[]
Show child fields
services[].edges[].aliases[]
Show child fields
services[].edges[].aliases[].name

The canonical name of the alias.

services[].edges[].aliases[].names[]
services[].edges[].aliases[].type

The type of the alias.

services[].edges[].edge_type

Describes an asynchronous connection, with a value of link.

services[].edges[].end_time

The end time of the last segment on the edge.

services[].edges[].received_event_age_histogram[]
Show child fields
services[].edges[].received_event_age_histogram[].count

The prevalence of the entry.

services[].edges[].received_event_age_histogram[].value

The value of the entry.

services[].edges[].reference_id

Identifier of the edge. Unique within a service map.

services[].edges[].response_time_histogram[]
Show child fields
services[].edges[].response_time_histogram[].count

The prevalence of the entry.

services[].edges[].response_time_histogram[].value

The value of the entry.

services[].edges[].start_time

The start time of the first segment on the edge.

services[].edges[].summary_statistics

Response statistics for segments on the edge.

Show child fields
services[].edges[].summary_statistics.error_statistics

Information about requests that failed with a 4xx Client Error status code.

Show child fields
services[].edges[].summary_statistics.error_statistics.other_count

The number of requests that failed with untracked 4xx Client Error status codes.

services[].edges[].summary_statistics.error_statistics.throttle_count

The number of requests that failed with a 419 throttling status code.

services[].edges[].summary_statistics.error_statistics.total_count

The total number of requests that failed with a 4xx Client Error status code.

services[].edges[].summary_statistics.fault_statistics

Information about requests that failed with a 5xx Server Error status code.

Show child fields
services[].edges[].summary_statistics.fault_statistics.other_count

The number of requests that failed with untracked 5xx Server Error status codes.

services[].edges[].summary_statistics.fault_statistics.total_count

The total number of requests that failed with a 5xx Server Error status code.

services[].edges[].summary_statistics.ok_count

The number of requests that completed with a 2xx Success status code.

services[].edges[].summary_statistics.total_count

The total number of completed requests.

services[].edges[].summary_statistics.total_response_time

The aggregate response time of completed requests.

services[].end_time

The end time of the last segment that the service generated.

services[].name

The canonical name of the service.

services[].names[]
services[].reference_id

Identifier for the service. Unique within the service map.

services[].response_time_histogram[]
Show child fields
services[].response_time_histogram[].count

The prevalence of the entry.

services[].response_time_histogram[].value

The value of the entry.

services[].root

Indicates that the service was the first service to process a request.

services[].start_time

The start time of the first segment that the service generated.

services[].state

The service's state.

services[].summary_statistics

Aggregated statistics for the service.

Show child fields
services[].summary_statistics.error_statistics

Information about requests that failed with a 4xx Client Error status code.

Show child fields
services[].summary_statistics.error_statistics.other_count

The number of requests that failed with untracked 4xx Client Error status codes.

services[].summary_statistics.error_statistics.throttle_count

The number of requests that failed with a 419 throttling status code.

services[].summary_statistics.error_statistics.total_count

The total number of requests that failed with a 4xx Client Error status code.

services[].summary_statistics.fault_statistics

Information about requests that failed with a 5xx Server Error status code.

Show child fields
services[].summary_statistics.fault_statistics.other_count

The number of requests that failed with untracked 5xx Server Error status codes.

services[].summary_statistics.fault_statistics.total_count

The total number of requests that failed with a 5xx Server Error status code.

services[].summary_statistics.ok_count

The number of requests that completed with a 2xx Success status code.

services[].summary_statistics.total_count

The total number of completed requests.

services[].summary_statistics.total_response_time

The aggregate response time of completed requests.

services[].type

The type of service.

  • Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.

  • Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.

  • client - Represents the clients that sent requests to a root service.

  • remote - A downstream service of indeterminate type.