XRay / Client / get_retrieved_traces_graph

get_retrieved_traces_graph#

XRay.Client.get_retrieved_traces_graph(**kwargs)#

Retrieves a service graph for traces based on the specified RetrievalToken from the CloudWatch log group generated by Transaction Search. This API does not initiate a retrieval job. You must first execute StartTraceRetrieval to obtain the required RetrievalToken.

The trace graph describes services that process incoming requests and any downstream services they call, which may include Amazon Web Services resources, external APIs, or databases.

The response is empty until the RetrievalStatus is COMPLETE. Retry the request after the status changes from RUNNING or SCHEDULED to COMPLETE to access the full service graph.

When CloudWatch log is the destination, this API can support cross-account observability and service graph retrieval across linked accounts.

For retrieving graphs from X-Ray directly as opposed to the Transaction-Search Log group, see GetTraceGraph.

See also: AWS API Documentation

Request Syntax

response = client.get_retrieved_traces_graph(
    RetrievalToken='string',
    NextToken='string'
)
Parameters:

  • RetrievalToken (string) –

    [REQUIRED]

    Retrieval token.

  • NextToken (string) – Specify the pagination token returned by a previous request to retrieve the next page of indexes.

Return type:

dict

Returns:

Response Syntax

{
    'RetrievalStatus': 'SCHEDULED'|'RUNNING'|'COMPLETE'|'FAILED'|'CANCELLED'|'TIMEOUT',
    'Services': [
        {
            'Service': {
                'ReferenceId': 123,
                'Name': 'string',
                'Names': [
                    'string',
                ],
                'Root': True|False,
                'AccountId': 'string',
                'Type': 'string',
                'State': 'string',
                'StartTime': datetime(2015, 1, 1),
                'EndTime': datetime(2015, 1, 1),
                'Edges': [
                    {
                        'ReferenceId': 123,
                        'StartTime': datetime(2015, 1, 1),
                        'EndTime': datetime(2015, 1, 1),
                        'SummaryStatistics': {
                            'OkCount': 123,
                            'ErrorStatistics': {
                                'ThrottleCount': 123,
                                'OtherCount': 123,
                                'TotalCount': 123
                            },
                            'FaultStatistics': {
                                'OtherCount': 123,
                                'TotalCount': 123
                            },
                            'TotalCount': 123,
                            'TotalResponseTime': 123.0
                        },
                        'ResponseTimeHistogram': [
                            {
                                'Value': 123.0,
                                'Count': 123
                            },
                        ],
                        'Aliases': [
                            {
                                'Name': 'string',
                                'Names': [
                                    'string',
                                ],
                                'Type': 'string'
                            },
                        ],
                        'EdgeType': 'string',
                        'ReceivedEventAgeHistogram': [
                            {
                                'Value': 123.0,
                                'Count': 123
                            },
                        ]
                    },
                ],
                'SummaryStatistics': {
                    'OkCount': 123,
                    'ErrorStatistics': {
                        'ThrottleCount': 123,
                        'OtherCount': 123,
                        'TotalCount': 123
                    },
                    'FaultStatistics': {
                        'OtherCount': 123,
                        'TotalCount': 123
                    },
                    'TotalCount': 123,
                    'TotalResponseTime': 123.0
                },
                'DurationHistogram': [
                    {
                        'Value': 123.0,
                        'Count': 123
                    },
                ],
                'ResponseTimeHistogram': [
                    {
                        'Value': 123.0,
                        'Count': 123
                    },
                ]
            },
            'Links': [
                {
                    'ReferenceType': 'string',
                    'SourceTraceId': 'string',
                    'DestinationTraceIds': [
                        'string',
                    ]
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RetrievalStatus (string) –

      Status of the retrieval.

    • Services (list) –

      Retrieved services.

      • (dict) –

        Retrieved information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.

        • Service (dict) –

          Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.

          • ReferenceId (integer) –

            Identifier for the service. Unique within the service map.

          • Name (string) –

            The canonical name of the service.

          • Names (list) –

            A list of names for the service, including the canonical name.

            • (string) –

          • Root (boolean) –

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

          • AccountId (string) –

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

          • Type (string) –

            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.

          • State (string) –

            The service’s state.

          • StartTime (datetime) –

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

          • EndTime (datetime) –

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

          • Edges (list) –

            Connections to downstream services.

            • (dict) –

              Information about a connection between two services. An edge can be a synchronous connection, such as typical call between client and service, or an asynchronous link, such as a Lambda function which retrieves an event from an SNS queue.

              • ReferenceId (integer) –

                Identifier of the edge. Unique within a service map.

              • StartTime (datetime) –

                The start time of the first segment on the edge.

              • EndTime (datetime) –

                The end time of the last segment on the edge.

              • SummaryStatistics (dict) –

                Response statistics for segments on the edge.

                • OkCount (integer) –

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

                • ErrorStatistics (dict) –

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

                  • ThrottleCount (integer) –

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

                  • OtherCount (integer) –

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

                  • TotalCount (integer) –

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

                • FaultStatistics (dict) –

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

                  • OtherCount (integer) –

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

                  • TotalCount (integer) –

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

                • TotalCount (integer) –

                  The total number of completed requests.

                • TotalResponseTime (float) –

                  The aggregate response time of completed requests.

              • ResponseTimeHistogram (list) –

                A histogram that maps the spread of client response times on an edge. Only populated for synchronous edges.

                • (dict) –

                  An entry in a histogram for a statistic. A histogram maps the range of observed values on the X axis, and the prevalence of each value on the Y axis.

                  • Value (float) –

                    The value of the entry.

                  • Count (integer) –

                    The prevalence of the entry.

              • Aliases (list) –

                Aliases for the edge.

                • (dict) –

                  An alias for an edge.

                  • Name (string) –

                    The canonical name of the alias.

                  • Names (list) –

                    A list of names for the alias, including the canonical name.

                    • (string) –

                  • Type (string) –

                    The type of the alias.

              • EdgeType (string) –

                Describes an asynchronous connection, with a value of link.

              • ReceivedEventAgeHistogram (list) –

                A histogram that maps the spread of event age when received by consumers. Age is calculated each time an event is received. Only populated when EdgeType is link.

                • (dict) –

                  An entry in a histogram for a statistic. A histogram maps the range of observed values on the X axis, and the prevalence of each value on the Y axis.

                  • Value (float) –

                    The value of the entry.

                  • Count (integer) –

                    The prevalence of the entry.

          • SummaryStatistics (dict) –

            Aggregated statistics for the service.

            • OkCount (integer) –

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

            • ErrorStatistics (dict) –

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

              • ThrottleCount (integer) –

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

              • OtherCount (integer) –

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

              • TotalCount (integer) –

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

            • FaultStatistics (dict) –

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

              • OtherCount (integer) –

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

              • TotalCount (integer) –

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

            • TotalCount (integer) –

              The total number of completed requests.

            • TotalResponseTime (float) –

              The aggregate response time of completed requests.

          • DurationHistogram (list) –

            A histogram that maps the spread of service durations.

            • (dict) –

              An entry in a histogram for a statistic. A histogram maps the range of observed values on the X axis, and the prevalence of each value on the Y axis.

              • Value (float) –

                The value of the entry.

              • Count (integer) –

                The prevalence of the entry.

          • ResponseTimeHistogram (list) –

            A histogram that maps the spread of service response times.

            • (dict) –

              An entry in a histogram for a statistic. A histogram maps the range of observed values on the X axis, and the prevalence of each value on the Y axis.

              • Value (float) –

                The value of the entry.

              • Count (integer) –

                The prevalence of the entry.

        • Links (list) –

          Relation between two 2 services.

          • (dict) –

            The relation between two services.

            • ReferenceType (string) –

              Relationship of a trace to the corresponding service.

            • SourceTraceId (string) –

              Source trace of a link relationship.

            • DestinationTraceIds (list) –

              Destination traces of a link relationship.

              • (string) –

    • NextToken (string) –

      Specify the pagination token returned by a previous request to retrieve the next page of indexes.

Exceptions

  • XRay.Client.exceptions.InvalidRequestException

  • XRay.Client.exceptions.ThrottledException

  • XRay.Client.exceptions.ResourceNotFoundException