lib/aws-sdk-xray/client.rb in aws-sdk-xray-1.0.0.rc6 vs lib/aws-sdk-xray/client.rb in aws-sdk-xray-1.0.0.rc7

- old
+ new

@@ -264,10 +264,13 @@ # 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetServiceGraph AWS API Documentation # # @overload get_service_graph(params = {}) @@ -339,10 +342,13 @@ # 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceGraph AWS API Documentation # # @overload get_trace_graph(params = {}) @@ -354,10 +360,30 @@ # 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][1] in the *AWS + # X-Ray Developer Guide*. + # + # + # + # [1]: http://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html + # # @option params [required, Time,DateTime,Date,Integer,String] :start_time # The start of the time frame for which to retrieve traces. # # @option params [required, Time,DateTime,Date,Integer,String] :end_time # The end of the time frame for which to retrieve traces. @@ -492,53 +518,61 @@ # 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. # - # @option params [required, Array<String>] :trace_segment_documents - # A JSON document defining one or more segments or subsegments. Segments - # must include the following fields. + # Segments must include the following fields. For the full segment + # document schema, see [AWS X-Ray Segment Documents][1] in the *AWS + # X-Ray Developer Guide*. # - # **Required Segment Document Fields** + # **Required Segment Document Fields** # - # * `name` - The name of the service that handled the request. + # * `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. + # * `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. + # * `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`. + # * `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`. + # * `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. + # * `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: + # A `trace_id` consists of three numbers separated by hyphens. For + # example, 1-58406520-a006649127e371903a2de979. This includes: # - # **Trace ID Format** + # **Trace ID Format** # - # * The version number, i.e. `1`. + # * 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. + # * 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. + # * A 96-bit identifier for the trace, globally unique, in 24 + # hexadecimal digits. # + # + # + # [1]: http://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html + # + # @option params [required, Array<String>] :trace_segment_documents + # A string containing a JSON document defining one or more segments or + # subsegments. + # # @return [Types::PutTraceSegmentsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::PutTraceSegmentsResult#unprocessed_trace_segments #unprocessed_trace_segments} => Array&lt;Types::UnprocessedTraceSegment&gt; # # @example Request syntax with placeholder values @@ -574,10 +608,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-xray' - context[:gem_version] = '1.0.0.rc6' + context[:gem_version] = '1.0.0.rc7' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated