XRay / Client / get_service_graph

get_service_graph#

XRay.Client.get_service_graph(**kwargs)#

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.

Request Syntax

response = client.get_service_graph(
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    GroupName='string',
    GroupARN='string',
    NextToken='string'
)

Parameters:

StartTime (datetime) –
[REQUIRED]

The start of the time frame for which to generate a graph.
EndTime (datetime) –
[REQUIRED]

The end of the timeframe for which to generate a graph.
GroupName (string) – The name of a group based on which you want to generate a graph.
GroupARN (string) – The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.
NextToken (string) – Pagination token.

Return type:

dict

Returns:

Response Syntax

{
    'StartTime': datetime(2015, 1, 1),
    'EndTime': datetime(2015, 1, 1),
    'Services': [
        {
            '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
                },
            ]
        },
    ],
    'ContainsOldGroupVersions': True|False,
    'NextToken': 'string'
}

Response Structure

(dict) –
- StartTime (datetime) –
  
  The start of the time frame for which the graph was generated.
- EndTime (datetime) –
  
  The end of the time frame for which the graph was generated.
- Services (list) –
  
  The services that have processed a traced request during the specified time frame.
  - (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 419 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 419 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.
- ContainsOldGroupVersions (boolean) –
  
  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.
- NextToken (string) –
  
  Pagination token.

Exceptions

XRay.Client.exceptions.InvalidRequestException
XRay.Client.exceptions.ThrottledException