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
Overview
An API client for XRay. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::XRay::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
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_insight(params = {}) ⇒ Types::GetInsightResult
Retrieves the summary information of an insight.
-
#get_insight_events(params = {}) ⇒ Types::GetInsightEventsResult
X-Ray reevaluates insights periodically until they’re resolved, and records each intermediate state as an event.
-
#get_insight_impact_graph(params = {}) ⇒ Types::GetInsightImpactGraphResult
Retrieves a service graph structure filtered by the specified insight.
-
#get_insight_summaries(params = {}) ⇒ Types::GetInsightSummariesResult
Retrieves the summaries of all insights in the specified group matching the provided filter values.
-
#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 annotations for traces available for a specified time frame using an optional filter.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
-
#put_encryption_config(params = {}) ⇒ Types::PutEncryptionConfigResult
Updates the encryption configuration for X-Ray data.
-
#put_telemetry_records(params = {}) ⇒ Struct
Used by the Amazon Web Services X-Ray daemon to upload telemetry.
-
#put_trace_segments(params = {}) ⇒ Types::PutTraceSegmentsResult
Uploads segment documents to Amazon Web Services X-Ray.
-
#tag_resource(params = {}) ⇒ Struct
Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from an Amazon Web Services X-Ray group or sampling rule.
-
#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.
333 334 335 |
# File 'lib/aws-sdk-xray/client.rb', line 333 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.
2046 2047 2048 |
# File 'lib/aws-sdk-xray/client.rb', line 2046 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.
2049 2050 2051 |
# File 'lib/aws-sdk-xray/client.rb', line 2049 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
381 382 383 384 |
# File 'lib/aws-sdk-xray/client.rb', line 381 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.
2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 |
# File 'lib/aws-sdk-xray/client.rb', line 2024 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.43.0' Seahorse::Client::Request.new(handlers, context) end |
#create_group(params = {}) ⇒ Types::CreateGroupResult
Creates a group resource with a name and a filter expression.
464 465 466 467 |
# File 'lib/aws-sdk-xray/client.rb', line 464 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.
[1]: docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html [2]: docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html
567 568 569 570 |
# File 'lib/aws-sdk-xray/client.rb', line 567 def create_sampling_rule(params = {}, = {}) req = build_request(:create_sampling_rule, params) req.send_request() end |
#delete_group(params = {}) ⇒ Struct
Deletes a group resource.
593 594 595 596 |
# File 'lib/aws-sdk-xray/client.rb', line 593 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() end |
#delete_sampling_rule(params = {}) ⇒ Types::DeleteSamplingRuleResult
Deletes a sampling rule.
642 643 644 645 |
# File 'lib/aws-sdk-xray/client.rb', line 642 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.
663 664 665 666 |
# File 'lib/aws-sdk-xray/client.rb', line 663 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.
699 700 701 702 |
# File 'lib/aws-sdk-xray/client.rb', line 699 def get_group(params = {}, = {}) req = build_request(:get_group, params) req.send_request() end |
#get_groups(params = {}) ⇒ Types::GetGroupsResult
Retrieves all active group details.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
736 737 738 739 |
# File 'lib/aws-sdk-xray/client.rb', line 736 def get_groups(params = {}, = {}) req = build_request(:get_groups, params) req.send_request() end |
#get_insight(params = {}) ⇒ Types::GetInsightResult
Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.
793 794 795 796 |
# File 'lib/aws-sdk-xray/client.rb', line 793 def get_insight(params = {}, = {}) req = build_request(:get_insight, params) req.send_request() end |
#get_insight_events(params = {}) ⇒ Types::GetInsightEventsResult
X-Ray reevaluates insights periodically until they’re resolved, and records each intermediate state as an event. You can review an insight’s events in the Impact Timeline on the Inspect page in the X-Ray console.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
852 853 854 855 |
# File 'lib/aws-sdk-xray/client.rb', line 852 def get_insight_events(params = {}, = {}) req = build_request(:get_insight_events, params) req.send_request() end |
#get_insight_impact_graph(params = {}) ⇒ Types::GetInsightImpactGraphResult
Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.
920 921 922 923 |
# File 'lib/aws-sdk-xray/client.rb', line 920 def get_insight_impact_graph(params = {}, = {}) req = build_request(:get_insight_impact_graph, params) req.send_request() end |
#get_insight_summaries(params = {}) ⇒ Types::GetInsightSummariesResult
Retrieves the summaries of all insights in the specified group matching the provided filter values.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1007 1008 1009 1010 |
# File 'lib/aws-sdk-xray/client.rb', line 1007 def get_insight_summaries(params = {}, = {}) req = build_request(:get_insight_summaries, params) req.send_request() end |
#get_sampling_rules(params = {}) ⇒ Types::GetSamplingRulesResult
Retrieves all sampling rules.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1055 1056 1057 1058 |
# File 'lib/aws-sdk-xray/client.rb', line 1055 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1093 1094 1095 1096 |
# File 'lib/aws-sdk-xray/client.rb', line 1093 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.
1143 1144 1145 1146 |
# File 'lib/aws-sdk-xray/client.rb', line 1143 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 [Amazon Web Services X-Ray SDK]. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.
[1]: docs.aws.amazon.com/xray/index.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1251 1252 1253 1254 |
# File 'lib/aws-sdk-xray/client.rb', line 1251 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1341 1342 1343 1344 |
# File 'lib/aws-sdk-xray/client.rb', line 1341 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1421 1422 1423 1424 |
# File 'lib/aws-sdk-xray/client.rb', line 1421 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 annotations 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 *Amazon Web Services X-Ray Developer Guide*.
[1]: docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1603 1604 1605 1606 |
# File 'lib/aws-sdk-xray/client.rb', line 1603 def get_trace_summaries(params = {}, = {}) req = build_request(:get_trace_summaries, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
1642 1643 1644 1645 |
# File 'lib/aws-sdk-xray/client.rb', line 1642 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_encryption_config(params = {}) ⇒ Types::PutEncryptionConfigResult
Updates the encryption configuration for X-Ray data.
1690 1691 1692 1693 |
# File 'lib/aws-sdk-xray/client.rb', line 1690 def put_encryption_config(params = {}, = {}) req = build_request(:put_encryption_config, params) req.send_request() end |
#put_telemetry_records(params = {}) ⇒ Struct
Used by the Amazon Web Services X-Ray daemon to upload telemetry.
1736 1737 1738 1739 |
# File 'lib/aws-sdk-xray/client.rb', line 1736 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 Amazon Web Services 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 [Amazon Web Services X-Ray Segment Documents] in the *Amazon Web Services 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 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, for instance, ‘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/index.html [2]: docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html
1819 1820 1821 1822 |
# File 'lib/aws-sdk-xray/client.rb', line 1819 def put_trace_segments(params = {}, = {}) req = build_request(:put_trace_segments, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
1874 1875 1876 1877 |
# File 'lib/aws-sdk-xray/client.rb', line 1874 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an ‘aws:` prefix).
1902 1903 1904 1905 |
# File 'lib/aws-sdk-xray/client.rb', line 1902 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_group(params = {}) ⇒ Types::UpdateGroupResult
Updates a group resource.
1957 1958 1959 1960 |
# File 'lib/aws-sdk-xray/client.rb', line 1957 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.
2015 2016 2017 2018 |
# File 'lib/aws-sdk-xray/client.rb', line 2015 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.
2039 2040 2041 |
# File 'lib/aws-sdk-xray/client.rb', line 2039 def waiter_names [] end |