Class: Aws::XRay::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::XRay::Client

show all

Includes:: ClientStubs

Defined in:: lib/aws-sdk-xray/client.rb

Class Attribute Summary collapse

.identifier ⇒ Object readonly private

API Operations collapse

#batch_get_traces(params = {}) ⇒ Types::BatchGetTracesResult

Retrieves a list of traces specified by ID.
#get_service_graph(params = {}) ⇒ Types::GetServiceGraphResult

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result.
#get_trace_graph(params = {}) ⇒ Types::GetTraceGraphResult

Retrieves a service graph for one or more specific trace IDs.
#get_trace_summaries(params = {}) ⇒ Types::GetTraceSummariesResult

Retrieves IDs and metadata for traces available for a specified time frame using an optional filter.
#put_telemetry_records(params = {}) ⇒ Struct

Used by the AWS X-Ray daemon to upload telemetry.
#put_trace_segments(params = {}) ⇒ Types::PutTraceSegmentsResult

Uploads segment documents to AWS X-Ray.

Class Method Summary collapse

.errors_module ⇒ Object private

Instance Method Summary collapse

#build_request(operation_name, params = {}) ⇒ Object private
#initialize(*args) ⇒ Client constructor

A new instance of Client.
#waiter_names ⇒ Object deprecated private Deprecated.

Constructor Details

#initialize(*args) ⇒ `Client`

Returns a new instance of Client.

Parameters:

options (Hash) —

a customizable set of options



142
143
144

# File 'lib/aws-sdk-xray/client.rb', line 142

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



626
627
628

# File 'lib/aws-sdk-xray/client.rb', line 626

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



629
630
631

# File 'lib/aws-sdk-xray/client.rb', line 629

def errors_module
  Errors
end

Instance Method Details

#batch_get_traces(params = {}) ⇒ `Types::BatchGetTracesResult`

Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use ‘GetTraceSummaries` to get a list of trace IDs.

Examples:

Request syntax with placeholder values


resp = client.batch_get_traces({
  trace_ids: ["TraceId"], # required
  next_token: "String",
})

Response structure


resp.traces #=> Array
resp.traces[0].id #=> String
resp.traces[0].duration #=> Float
resp.traces[0].segments #=> Array
resp.traces[0].segments[0].id #=> String
resp.traces[0].segments[0].document #=> String
resp.unprocessed_trace_ids #=> Array
resp.unprocessed_trace_ids[0] #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:trace_ids (required, Array<String>) —

Specify the trace IDs of requests for which to retrieve segments.
:next_token (String) —

Pagination token. Not used.

Returns:

(Types::BatchGetTracesResult) —
Returns a response object which responds to the following methods:
- #traces => Array<Types::Trace>
- #unprocessed_trace_ids => Array<String>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 187

def batch_get_traces(params = {}, options = {})
  req = build_request(:batch_get_traces, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

params ({}) (defaults to: {})

# File 'lib/aws-sdk-xray/client.rb', line 604

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-xray'
  context[:gem_version] = '1.0.0'
  Seahorse::Client::Request.new(handlers, context)
end

#get_service_graph(params = {}) ⇒ `Types::GetServiceGraphResult`

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 AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.

Examples:

Request syntax with placeholder values


resp = client.get_service_graph({
  start_time: Time.now, # required
  end_time: Time.now, # required
  next_token: "String",
})

Response structure


resp.start_time #=> Time
resp.end_time #=> Time
resp.services #=> Array
resp.services[0].reference_id #=> Integer
resp.services[0].name #=> String
resp.services[0].names #=> Array
resp.services[0].names[0] #=> String
resp.services[0].root #=> Boolean
resp.services[0].account_id #=> String
resp.services[0].type #=> String
resp.services[0].state #=> String
resp.services[0].start_time #=> Time
resp.services[0].end_time #=> Time
resp.services[0].edges #=> Array
resp.services[0].edges[0].reference_id #=> Integer
resp.services[0].edges[0].start_time #=> Time
resp.services[0].edges[0].end_time #=> Time
resp.services[0].edges[0].summary_statistics.ok_count #=> Integer
resp.services[0].edges[0].summary_statistics.error_statistics.throttle_count #=> Integer
resp.services[0].edges[0].summary_statistics.error_statistics.other_count #=> Integer
resp.services[0].edges[0].summary_statistics.error_statistics.total_count #=> Integer
resp.services[0].edges[0].summary_statistics.fault_statistics.other_count #=> Integer
resp.services[0].edges[0].summary_statistics.fault_statistics.total_count #=> Integer
resp.services[0].edges[0].summary_statistics.total_count #=> Integer
resp.services[0].edges[0].summary_statistics.total_response_time #=> Float
resp.services[0].edges[0].response_time_histogram #=> Array
resp.services[0].edges[0].response_time_histogram[0].value #=> Float
resp.services[0].edges[0].response_time_histogram[0].count #=> Integer
resp.services[0].edges[0].aliases #=> Array
resp.services[0].edges[0].aliases[0].name #=> String
resp.services[0].edges[0].aliases[0].names #=> Array
resp.services[0].edges[0].aliases[0].names[0] #=> String
resp.services[0].edges[0].aliases[0].type #=> String
resp.services[0].summary_statistics.ok_count #=> Integer
resp.services[0].summary_statistics.error_statistics.throttle_count #=> Integer
resp.services[0].summary_statistics.error_statistics.other_count #=> Integer
resp.services[0].summary_statistics.error_statistics.total_count #=> Integer
resp.services[0].summary_statistics.fault_statistics.other_count #=> Integer
resp.services[0].summary_statistics.fault_statistics.total_count #=> Integer
resp.services[0].summary_statistics.total_count #=> Integer
resp.services[0].summary_statistics.total_response_time #=> Float
resp.services[0].duration_histogram #=> Array
resp.services[0].duration_histogram[0].value #=> Float
resp.services[0].duration_histogram[0].count #=> Integer
resp.services[0].response_time_histogram #=> Array
resp.services[0].response_time_histogram[0].value #=> Float
resp.services[0].response_time_histogram[0].count #=> Integer
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:start_time (required, Time, DateTime, Date, Integer, String) —

The start of the time frame for which to generate a graph.
:end_time (required, Time, DateTime, Date, Integer, String) —

The end of the time frame for which to generate a graph.
:next_token (String) —

Pagination token. Not used.

Returns:

(Types::GetServiceGraphResult) —
Returns a response object which responds to the following methods:
- #start_time => Time
- #end_time => Time
- #services => Array<Types::Service>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 278

def get_service_graph(params = {}, options = {})
  req = build_request(:get_service_graph, params)
  req.send_request(options)
end

#get_trace_graph(params = {}) ⇒ `Types::GetTraceGraphResult`

Retrieves a service graph for one or more specific trace IDs.

Examples:

Request syntax with placeholder values


resp = client.get_trace_graph({
  trace_ids: ["TraceId"], # required
  next_token: "String",
})

Response structure


resp.services #=> Array
resp.services[0].reference_id #=> Integer
resp.services[0].name #=> String
resp.services[0].names #=> Array
resp.services[0].names[0] #=> String
resp.services[0].root #=> Boolean
resp.services[0].account_id #=> String
resp.services[0].type #=> String
resp.services[0].state #=> String
resp.services[0].start_time #=> Time
resp.services[0].end_time #=> Time
resp.services[0].edges #=> Array
resp.services[0].edges[0].reference_id #=> Integer
resp.services[0].edges[0].start_time #=> Time
resp.services[0].edges[0].end_time #=> Time
resp.services[0].edges[0].summary_statistics.ok_count #=> Integer
resp.services[0].edges[0].summary_statistics.error_statistics.throttle_count #=> Integer
resp.services[0].edges[0].summary_statistics.error_statistics.other_count #=> Integer
resp.services[0].edges[0].summary_statistics.error_statistics.total_count #=> Integer
resp.services[0].edges[0].summary_statistics.fault_statistics.other_count #=> Integer
resp.services[0].edges[0].summary_statistics.fault_statistics.total_count #=> Integer
resp.services[0].edges[0].summary_statistics.total_count #=> Integer
resp.services[0].edges[0].summary_statistics.total_response_time #=> Float
resp.services[0].edges[0].response_time_histogram #=> Array
resp.services[0].edges[0].response_time_histogram[0].value #=> Float
resp.services[0].edges[0].response_time_histogram[0].count #=> Integer
resp.services[0].edges[0].aliases #=> Array
resp.services[0].edges[0].aliases[0].name #=> String
resp.services[0].edges[0].aliases[0].names #=> Array
resp.services[0].edges[0].aliases[0].names[0] #=> String
resp.services[0].edges[0].aliases[0].type #=> String
resp.services[0].summary_statistics.ok_count #=> Integer
resp.services[0].summary_statistics.error_statistics.throttle_count #=> Integer
resp.services[0].summary_statistics.error_statistics.other_count #=> Integer
resp.services[0].summary_statistics.error_statistics.total_count #=> Integer
resp.services[0].summary_statistics.fault_statistics.other_count #=> Integer
resp.services[0].summary_statistics.fault_statistics.total_count #=> Integer
resp.services[0].summary_statistics.total_count #=> Integer
resp.services[0].summary_statistics.total_response_time #=> Float
resp.services[0].duration_histogram #=> Array
resp.services[0].duration_histogram[0].value #=> Float
resp.services[0].duration_histogram[0].count #=> Integer
resp.services[0].response_time_histogram #=> Array
resp.services[0].response_time_histogram[0].value #=> Float
resp.services[0].response_time_histogram[0].count #=> Integer
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:trace_ids (required, Array<String>) —

Trace IDs of requests for which to generate a service graph.
:next_token (String) —

Pagination token. Not used.

Returns:

(Types::GetTraceGraphResult) —
Returns a response object which responds to the following methods:
- #services => Array<Types::Service>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 356

def get_trace_graph(params = {}, options = {})
  req = build_request(:get_trace_graph, params)
  req.send_request(options)
end

#get_trace_summaries(params = {}) ⇒ `Types::GetTraceSummariesResult`

Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to ‘BatchGetTraces`.

A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through ‘api.example.com`:

‘service(“api.example.com”)`

This filter expression finds traces that have an annotation named ‘account` with the value `12345`:

‘annotation.account = “12345”`

For a full list of indexed fields and keywords that you can use in filter expressions, see [Using Filter Expressions] in the *AWS X-Ray Developer Guide*.

[1]: docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html

Examples:

Request syntax with placeholder values


resp = client.get_trace_summaries({
  start_time: Time.now, # required
  end_time: Time.now, # required
  sampling: false,
  filter_expression: "FilterExpression",
  next_token: "String",
})

Response structure


resp.trace_summaries #=> Array
resp.trace_summaries[0].id #=> String
resp.trace_summaries[0].duration #=> Float
resp.trace_summaries[0].response_time #=> Float
resp.trace_summaries[0].has_fault #=> Boolean
resp.trace_summaries[0].has_error #=> Boolean
resp.trace_summaries[0].has_throttle #=> Boolean
resp.trace_summaries[0].is_partial #=> Boolean
resp.trace_summaries[0].http.http_url #=> String
resp.trace_summaries[0].http.http_status #=> Integer
resp.trace_summaries[0].http.http_method #=> String
resp.trace_summaries[0].http.user_agent #=> String
resp.trace_summaries[0].http.client_ip #=> String
resp.trace_summaries[0].annotations #=> Hash
resp.trace_summaries[0].annotations["AnnotationKey"] #=> Array
resp.trace_summaries[0].annotations["AnnotationKey"][0].annotation_value.number_value #=> Float
resp.trace_summaries[0].annotations["AnnotationKey"][0].annotation_value.boolean_value #=> Boolean
resp.trace_summaries[0].annotations["AnnotationKey"][0].annotation_value.string_value #=> String
resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids #=> Array
resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].name #=> String
resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].names #=> Array
resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].names[0] #=> String
resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].account_id #=> String
resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].type #=> String
resp.trace_summaries[0].users #=> Array
resp.trace_summaries[0].users[0].user_name #=> String
resp.trace_summaries[0].users[0].service_ids #=> Array
resp.trace_summaries[0].users[0].service_ids[0].name #=> String
resp.trace_summaries[0].users[0].service_ids[0].names #=> Array
resp.trace_summaries[0].users[0].service_ids[0].names[0] #=> String
resp.trace_summaries[0].users[0].service_ids[0].account_id #=> String
resp.trace_summaries[0].users[0].service_ids[0].type #=> String
resp.trace_summaries[0].service_ids #=> Array
resp.trace_summaries[0].service_ids[0].name #=> String
resp.trace_summaries[0].service_ids[0].names #=> Array
resp.trace_summaries[0].service_ids[0].names[0] #=> String
resp.trace_summaries[0].service_ids[0].account_id #=> String
resp.trace_summaries[0].service_ids[0].type #=> String
resp.approximate_time #=> Time
resp.traces_processed_count #=> Integer
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:start_time (required, Time, DateTime, Date, Integer, String) —

The start of the time frame for which to retrieve traces.
:end_time (required, Time, DateTime, Date, Integer, String) —

The end of the time frame for which to retrieve traces.
:sampling (Boolean) —

Set to ‘true` to get summaries for only a subset of available traces.
:filter_expression (String) —

Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
:next_token (String) —

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

Returns:

(Types::GetTraceSummariesResult) —
Returns a response object which responds to the following methods:
- #trace_summaries => Array<Types::TraceSummary>
- #approximate_time => Time
- #traces_processed_count => Integer
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 467

def get_trace_summaries(params = {}, options = {})
  req = build_request(:get_trace_summaries, params)
  req.send_request(options)
end

#put_telemetry_records(params = {}) ⇒ `Struct`

Used by the AWS X-Ray daemon to upload telemetry.

Examples:

Request syntax with placeholder values


resp = client.put_telemetry_records({
  telemetry_records: [ # required
    {
      timestamp: Time.now,
      segments_received_count: 1,
      segments_sent_count: 1,
      segments_spillover_count: 1,
      segments_rejected_count: 1,
      backend_connection_errors: {
        timeout_count: 1,
        connection_refused_count: 1,
        http_code_4_xx_count: 1,
        http_code_5_xx_count: 1,
        unknown_host_count: 1,
        other_count: 1,
      },
    },
  ],
  ec2_instance_id: "String",
  hostname: "String",
  resource_arn: "String",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:telemetry_records (required, Array<Types::TelemetryRecord>)
:ec2_instance_id (String)
:hostname (String)
:resource_arn (String)

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 513

def put_telemetry_records(params = {}, options = {})
  req = build_request(:put_telemetry_records, params)
  req.send_request(options)
end

#put_trace_segments(params = {}) ⇒ `Types::PutTraceSegmentsResult`

Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.

Segments must include the following fields. For the full segment document schema, see [AWS X-Ray Segment Documents] in the *AWS X-Ray Developer Guide*.

**Required Segment Document Fields**

‘name` - The name of the service that handled the request.
‘id` - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits.
‘trace_id` - A unique identifier that connects all segments and subsegments originating from a single client request.
‘start_time` - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, `1480615200.010` or `1.480615200010E9`.
‘end_time` - Time the segment or subsegment was closed. For example, `1480615200.090` or `1.480615200090E9`. Specify either an `end_time` or `in_progress`.
‘in_progress` - Set to `true` instead of specifying an `end_time` to record that a segment has been started, but is not complete. Send an in progress segment when your application receives a request that will take a long time to serve, to trace the fact that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment.

A ‘trace_id` consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes:

**Trace ID Format**

The version number, i.e. ‘1`.
The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is ‘1480615200` seconds, or `58406520` in hexadecimal.
A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.

[1]: docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html

Examples:

Request syntax with placeholder values


resp = client.put_trace_segments({
  trace_segment_documents: ["TraceSegmentDocument"], # required
})

Response structure


resp.unprocessed_trace_segments #=> Array
resp.unprocessed_trace_segments[0].id #=> String
resp.unprocessed_trace_segments[0].error_code #=> String
resp.unprocessed_trace_segments[0].message #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:trace_segment_documents (required, Array<String>) —

A string containing a JSON document defining one or more segments or subsegments.

Returns:

(Types::PutTraceSegmentsResult) —
Returns a response object which responds to the following methods:
- #unprocessed_trace_segments => Array<Types::UnprocessedTraceSegment>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 595

def put_trace_segments(params = {}, options = {})
  req = build_request(:put_trace_segments, params)
  req.send_request(options)
end

#waiter_names ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.



619
620
621

# File 'lib/aws-sdk-xray/client.rb', line 619

def waiter_names
  []
end

Class: Aws::XRay::Client

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Client

Class Attribute Details

.identifier ⇒ Object (readonly)

Class Method Details

.errors_module ⇒ Object

Instance Method Details

#batch_get_traces(params = {}) ⇒ Types::BatchGetTracesResult

#build_request(operation_name, params = {}) ⇒ Object

#get_service_graph(params = {}) ⇒ Types::GetServiceGraphResult

#get_trace_graph(params = {}) ⇒ Types::GetTraceGraphResult

#get_trace_summaries(params = {}) ⇒ Types::GetTraceSummariesResult

#put_telemetry_records(params = {}) ⇒ Struct

#put_trace_segments(params = {}) ⇒ Types::PutTraceSegmentsResult

#waiter_names ⇒ Object

#initialize(*args) ⇒ `Client`

.identifier ⇒ `Object` (readonly)

.errors_module ⇒ `Object`

#batch_get_traces(params = {}) ⇒ `Types::BatchGetTracesResult`

#build_request(operation_name, params = {}) ⇒ `Object`

#get_service_graph(params = {}) ⇒ `Types::GetServiceGraphResult`

#get_trace_graph(params = {}) ⇒ `Types::GetTraceGraphResult`

#get_trace_summaries(params = {}) ⇒ `Types::GetTraceSummariesResult`

#put_telemetry_records(params = {}) ⇒ `Struct`

#put_trace_segments(params = {}) ⇒ `Types::PutTraceSegmentsResult`

#waiter_names ⇒ `Object`