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_resource_policy(params = {}) ⇒ Struct
Deletes a resource policy from the target Amazon Web Services account.
-
#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_resource_policies(params = {}) ⇒ Types::ListResourcePoliciesResult
Returns the list of resource policies in the target Amazon Web Services account.
-
#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_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResult
Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray.
-
#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.
409 410 411 |
# File 'lib/aws-sdk-xray/client.rb', line 409 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.
2268 2269 2270 |
# File 'lib/aws-sdk-xray/client.rb', line 2268 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.
2271 2272 2273 |
# File 'lib/aws-sdk-xray/client.rb', line 2271 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.
457 458 459 460 |
# File 'lib/aws-sdk-xray/client.rb', line 457 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.
2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 |
# File 'lib/aws-sdk-xray/client.rb', line 2246 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.64.0' Seahorse::Client::Request.new(handlers, context) end |
#create_group(params = {}) ⇒ Types::CreateGroupResult
Creates a group resource with a name and a filter expression.
540 541 542 543 |
# File 'lib/aws-sdk-xray/client.rb', line 540 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
643 644 645 646 |
# File 'lib/aws-sdk-xray/client.rb', line 643 def create_sampling_rule(params = {}, = {}) req = build_request(:create_sampling_rule, params) req.send_request() end |
#delete_group(params = {}) ⇒ Struct
Deletes a group resource.
669 670 671 672 |
# File 'lib/aws-sdk-xray/client.rb', line 669 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a resource policy from the target Amazon Web Services account.
698 699 700 701 |
# File 'lib/aws-sdk-xray/client.rb', line 698 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, params) req.send_request() end |
#delete_sampling_rule(params = {}) ⇒ Types::DeleteSamplingRuleResult
Deletes a sampling rule.
747 748 749 750 |
# File 'lib/aws-sdk-xray/client.rb', line 747 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.
768 769 770 771 |
# File 'lib/aws-sdk-xray/client.rb', line 768 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.
804 805 806 807 |
# File 'lib/aws-sdk-xray/client.rb', line 804 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.
841 842 843 844 |
# File 'lib/aws-sdk-xray/client.rb', line 841 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.
898 899 900 901 |
# File 'lib/aws-sdk-xray/client.rb', line 898 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.
957 958 959 960 |
# File 'lib/aws-sdk-xray/client.rb', line 957 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.
1025 1026 1027 1028 |
# File 'lib/aws-sdk-xray/client.rb', line 1025 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.
1112 1113 1114 1115 |
# File 'lib/aws-sdk-xray/client.rb', line 1112 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.
1160 1161 1162 1163 |
# File 'lib/aws-sdk-xray/client.rb', line 1160 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.
1198 1199 1200 1201 |
# File 'lib/aws-sdk-xray/client.rb', line 1198 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.
1248 1249 1250 1251 |
# File 'lib/aws-sdk-xray/client.rb', line 1248 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.
1360 1361 1362 1363 |
# File 'lib/aws-sdk-xray/client.rb', line 1360 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.
1450 1451 1452 1453 |
# File 'lib/aws-sdk-xray/client.rb', line 1450 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.
1534 1535 1536 1537 |
# File 'lib/aws-sdk-xray/client.rb', line 1534 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.
1717 1718 1719 1720 |
# File 'lib/aws-sdk-xray/client.rb', line 1717 def get_trace_summaries(params = {}, = {}) req = build_request(:get_trace_summaries, params) req.send_request() end |
#list_resource_policies(params = {}) ⇒ Types::ListResourcePoliciesResult
Returns the list of resource policies in the target Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1754 1755 1756 1757 |
# File 'lib/aws-sdk-xray/client.rb', line 1754 def list_resource_policies(params = {}, = {}) req = build_request(:list_resource_policies, 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1795 1796 1797 1798 |
# File 'lib/aws-sdk-xray/client.rb', line 1795 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.
1843 1844 1845 1846 |
# File 'lib/aws-sdk-xray/client.rb', line 1843 def put_encryption_config(params = {}, = {}) req = build_request(:put_encryption_config, params) req.send_request() end |
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResult
Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.
1912 1913 1914 1915 |
# File 'lib/aws-sdk-xray/client.rb', line 1912 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, params) req.send_request() end |
#put_telemetry_records(params = {}) ⇒ Struct
Used by the Amazon Web Services X-Ray daemon to upload telemetry.
1958 1959 1960 1961 |
# File 'lib/aws-sdk-xray/client.rb', line 1958 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
2041 2042 2043 2044 |
# File 'lib/aws-sdk-xray/client.rb', line 2041 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.
2096 2097 2098 2099 |
# File 'lib/aws-sdk-xray/client.rb', line 2096 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).
2124 2125 2126 2127 |
# File 'lib/aws-sdk-xray/client.rb', line 2124 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_group(params = {}) ⇒ Types::UpdateGroupResult
Updates a group resource.
2179 2180 2181 2182 |
# File 'lib/aws-sdk-xray/client.rb', line 2179 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.
2237 2238 2239 2240 |
# File 'lib/aws-sdk-xray/client.rb', line 2237 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.
2261 2262 2263 |
# File 'lib/aws-sdk-xray/client.rb', line 2261 def waiter_names [] end |