Class: Aws::XRay::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::XRay::Client
- 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.
-
#create_group(params = {}) ⇒ Types::CreateGroupResult
Creates a group resource with a name and a filter expression.
-
#create_sampling_rule(params = {}) ⇒ Types::CreateSamplingRuleResult
Creates a rule to control sampling behavior for instrumented applications.
-
#delete_group(params = {}) ⇒ Struct
Deletes a group resource.
-
#delete_sampling_rule(params = {}) ⇒ Types::DeleteSamplingRuleResult
Deletes a sampling rule.
-
#get_encryption_config(params = {}) ⇒ Types::GetEncryptionConfigResult
Retrieves the current encryption configuration for X-Ray data.
-
#get_group(params = {}) ⇒ Types::GetGroupResult
Retrieves group resource details.
-
#get_groups(params = {}) ⇒ Types::GetGroupsResult
Retrieves all active group details.
-
#get_sampling_rules(params = {}) ⇒ Types::GetSamplingRulesResult
Retrieves all sampling rules.
-
#get_sampling_statistic_summaries(params = {}) ⇒ Types::GetSamplingStatisticSummariesResult
Retrieves information about recent sampling results for all sampling rules.
-
#get_sampling_targets(params = {}) ⇒ Types::GetSamplingTargetsResult
Requests a sampling quota for rules that the service is using to sample requests.
-
#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_time_series_service_statistics(params = {}) ⇒ Types::GetTimeSeriesServiceStatisticsResult
Get an aggregation of service statistics defined by a specific time range.
-
#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_encryption_config(params = {}) ⇒ Types::PutEncryptionConfigResult
Updates the encryption configuration for X-Ray data.
-
#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.
-
#update_group(params = {}) ⇒ Types::UpdateGroupResult
Updates a group resource.
-
#update_sampling_rule(params = {}) ⇒ Types::UpdateSamplingRuleResult
Modifies a sampling rule’s configuration.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
251 252 253 |
# File 'lib/aws-sdk-xray/client.rb', line 251 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.
1431 1432 1433 |
# File 'lib/aws-sdk-xray/client.rb', line 1431 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.
1434 1435 1436 |
# File 'lib/aws-sdk-xray/client.rb', line 1434 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.
296 297 298 299 |
# File 'lib/aws-sdk-xray/client.rb', line 296 def batch_get_traces(params = {}, = {}) req = build_request(:batch_get_traces, params) req.send_request() 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.
1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 |
# File 'lib/aws-sdk-xray/client.rb', line 1409 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.21.0' Seahorse::Client::Request.new(handlers, context) end |
#create_group(params = {}) ⇒ Types::CreateGroupResult
Creates a group resource with a name and a filter expression.
331 332 333 334 |
# File 'lib/aws-sdk-xray/client.rb', line 331 def create_group(params = {}, = {}) req = build_request(:create_group, params) req.send_request() end |
#create_sampling_rule(params = {}) ⇒ Types::CreateSamplingRuleResult
Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.
397 398 399 400 |
# File 'lib/aws-sdk-xray/client.rb', line 397 def create_sampling_rule(params = {}, = {}) req = build_request(:create_sampling_rule, params) req.send_request() end |
#delete_group(params = {}) ⇒ Struct
Deletes a group resource.
423 424 425 426 |
# File 'lib/aws-sdk-xray/client.rb', line 423 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() end |
#delete_sampling_rule(params = {}) ⇒ Types::DeleteSamplingRuleResult
Deletes a sampling rule.
472 473 474 475 |
# File 'lib/aws-sdk-xray/client.rb', line 472 def delete_sampling_rule(params = {}, = {}) req = build_request(:delete_sampling_rule, params) req.send_request() end |
#get_encryption_config(params = {}) ⇒ Types::GetEncryptionConfigResult
Retrieves the current encryption configuration for X-Ray data.
493 494 495 496 |
# File 'lib/aws-sdk-xray/client.rb', line 493 def get_encryption_config(params = {}, = {}) req = build_request(:get_encryption_config, params) req.send_request() end |
#get_group(params = {}) ⇒ Types::GetGroupResult
Retrieves group resource details.
527 528 529 530 |
# File 'lib/aws-sdk-xray/client.rb', line 527 def get_group(params = {}, = {}) req = build_request(:get_group, params) req.send_request() end |
#get_groups(params = {}) ⇒ Types::GetGroupsResult
Retrieves all active group details.
560 561 562 563 |
# File 'lib/aws-sdk-xray/client.rb', line 560 def get_groups(params = {}, = {}) req = build_request(:get_groups, params) req.send_request() end |
#get_sampling_rules(params = {}) ⇒ Types::GetSamplingRulesResult
Retrieves all sampling rules.
606 607 608 609 |
# File 'lib/aws-sdk-xray/client.rb', line 606 def get_sampling_rules(params = {}, = {}) req = build_request(:get_sampling_rules, params) req.send_request() end |
#get_sampling_statistic_summaries(params = {}) ⇒ Types::GetSamplingStatisticSummariesResult
Retrieves information about recent sampling results for all sampling rules.
642 643 644 645 |
# File 'lib/aws-sdk-xray/client.rb', line 642 def get_sampling_statistic_summaries(params = {}, = {}) req = build_request(:get_sampling_statistic_summaries, params) req.send_request() end |
#get_sampling_targets(params = {}) ⇒ Types::GetSamplingTargetsResult
Requests a sampling quota for rules that the service is using to sample requests.
692 693 694 695 |
# File 'lib/aws-sdk-xray/client.rb', line 692 def get_sampling_targets(params = {}, = {}) req = build_request(:get_sampling_targets, params) req.send_request() 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.
793 794 795 796 |
# File 'lib/aws-sdk-xray/client.rb', line 793 def get_service_graph(params = {}, = {}) req = build_request(:get_service_graph, params) req.send_request() end |
#get_time_series_service_statistics(params = {}) ⇒ Types::GetTimeSeriesServiceStatisticsResult
Get an aggregation of service statistics defined by a specific time range.
873 874 875 876 |
# File 'lib/aws-sdk-xray/client.rb', line 873 def get_time_series_service_statistics(params = {}, = {}) req = build_request(:get_time_series_service_statistics, params) req.send_request() end |
#get_trace_graph(params = {}) ⇒ Types::GetTraceGraphResult
Retrieves a service graph for one or more specific trace IDs.
951 952 953 954 |
# File 'lib/aws-sdk-xray/client.rb', line 951 def get_trace_graph(params = {}, = {}) req = build_request(:get_trace_graph, params) req.send_request() 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
1128 1129 1130 1131 |
# File 'lib/aws-sdk-xray/client.rb', line 1128 def get_trace_summaries(params = {}, = {}) req = build_request(:get_trace_summaries, params) req.send_request() end |
#put_encryption_config(params = {}) ⇒ Types::PutEncryptionConfigResult
Updates the encryption configuration for X-Ray data.
1175 1176 1177 1178 |
# File 'lib/aws-sdk-xray/client.rb', line 1175 def put_encryption_config(params = {}, = {}) req = build_request(:put_encryption_config, params) req.send_request() end |
#put_telemetry_records(params = {}) ⇒ Struct
Used by the AWS X-Ray daemon to upload telemetry.
1221 1222 1223 1224 |
# File 'lib/aws-sdk-xray/client.rb', line 1221 def put_telemetry_records(params = {}, = {}) req = build_request(:put_telemetry_records, params) req.send_request() 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
1303 1304 1305 1306 |
# File 'lib/aws-sdk-xray/client.rb', line 1303 def put_trace_segments(params = {}, = {}) req = build_request(:put_trace_segments, params) req.send_request() end |
#update_group(params = {}) ⇒ Types::UpdateGroupResult
Updates a group resource.
1342 1343 1344 1345 |
# File 'lib/aws-sdk-xray/client.rb', line 1342 def update_group(params = {}, = {}) req = build_request(:update_group, params) req.send_request() end |
#update_sampling_rule(params = {}) ⇒ Types::UpdateSamplingRuleResult
Modifies a sampling rule’s configuration.
1400 1401 1402 1403 |
# File 'lib/aws-sdk-xray/client.rb', line 1400 def update_sampling_rule(params = {}, = {}) req = build_request(:update_sampling_rule, params) req.send_request() 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.
1424 1425 1426 |
# File 'lib/aws-sdk-xray/client.rb', line 1424 def waiter_names [] end |