Class: Aws::XRay::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::XRay::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-xray/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
365 366 367 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 365 def initialize(*args) super 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.
413 414 415 416 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 413 def batch_get_traces(params = {}, = {}) req = build_request(:batch_get_traces, params) req.send_request() end |
#create_group(params = {}) ⇒ Types::CreateGroupResult
Creates a group resource with a name and a filter expression.
496 497 498 499 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 496 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.
599 600 601 602 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 599 def create_sampling_rule(params = {}, = {}) req = build_request(:create_sampling_rule, params) req.send_request() end |
#delete_group(params = {}) ⇒ Struct
Deletes a group resource.
625 626 627 628 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 625 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.
654 655 656 657 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 654 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.
703 704 705 706 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 703 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.
724 725 726 727 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 724 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.
760 761 762 763 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 760 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.
797 798 799 800 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 797 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.
854 855 856 857 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 854 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.
913 914 915 916 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 913 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.
981 982 983 984 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 981 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.
1068 1069 1070 1071 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 1068 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.
1116 1117 1118 1119 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 1116 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.
1154 1155 1156 1157 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 1154 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.
1204 1205 1206 1207 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 1204 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1316 1317 1318 1319 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 1316 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.
1406 1407 1408 1409 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 1406 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.
1490 1491 1492 1493 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 1490 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1672 1673 1674 1675 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 1672 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.
1709 1710 1711 1712 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 1709 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.
1750 1751 1752 1753 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 1750 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.
1798 1799 1800 1801 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 1798 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.
1867 1868 1869 1870 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 1867 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.
1913 1914 1915 1916 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 1913 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
or1.480615200010E9
.end_time
- Time the segment or subsegment was closed. For example,1480615200.090
or1.480615200090E9
. Specify either anend_time
orin_progress
.in_progress
- Set totrue
instead of specifying anend_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, or58406520
in hexadecimal.A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.
1996 1997 1998 1999 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 1996 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.
2051 2052 2053 2054 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 2051 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).
2079 2080 2081 2082 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 2079 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_group(params = {}) ⇒ Types::UpdateGroupResult
Updates a group resource.
2134 2135 2136 2137 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 2134 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.
2192 2193 2194 2195 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/client.rb', line 2192 def update_sampling_rule(params = {}, = {}) req = build_request(:update_sampling_rule, params) req.send_request() end |