XRay

public struct XRay

Client object for interacting with AWS XRay service.

AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.

Member variables

Initialization

  • Initialize the XRay client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • 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.

    Declaration

    Swift

    public func batchGetTraces(_ input: BatchGetTracesRequest) -> EventLoopFuture<BatchGetTracesResult>

  • Creates a group resource with a name and a filter expression.

    Declaration

    Swift

    public func createGroup(_ input: CreateGroupRequest) -> EventLoopFuture<CreateGroupResult>

  • 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.

    Declaration

    Swift

    public func createSamplingRule(_ input: CreateSamplingRuleRequest) -> EventLoopFuture<CreateSamplingRuleResult>

  • Deletes a group resource.

    Declaration

    Swift

    public func deleteGroup(_ input: DeleteGroupRequest) -> EventLoopFuture<DeleteGroupResult>

  • Deletes a sampling rule.

    Declaration

    Swift

    public func deleteSamplingRule(_ input: DeleteSamplingRuleRequest) -> EventLoopFuture<DeleteSamplingRuleResult>

  • Retrieves the current encryption configuration for X-Ray data.

    Declaration

    Swift

    public func getEncryptionConfig(_ input: GetEncryptionConfigRequest) -> EventLoopFuture<GetEncryptionConfigResult>

  • Retrieves group resource details.

    Declaration

    Swift

    public func getGroup(_ input: GetGroupRequest) -> EventLoopFuture<GetGroupResult>

  • Retrieves all active group details.

    Declaration

    Swift

    public func getGroups(_ input: GetGroupsRequest) -> EventLoopFuture<GetGroupsResult>

  • Retrieves all sampling rules.

    Declaration

    Swift

    public func getSamplingRules(_ input: GetSamplingRulesRequest) -> EventLoopFuture<GetSamplingRulesResult>

  • Retrieves information about recent sampling results for all sampling rules.

    Declaration

    Swift

    public func getSamplingStatisticSummaries(_ input: GetSamplingStatisticSummariesRequest) -> EventLoopFuture<GetSamplingStatisticSummariesResult>

  • Requests a sampling quota for rules that the service is using to sample requests.

    Declaration

    Swift

    public func getSamplingTargets(_ input: GetSamplingTargetsRequest) -> EventLoopFuture<GetSamplingTargetsResult>

  • 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.

    Declaration

    Swift

    public func getServiceGraph(_ input: GetServiceGraphRequest) -> EventLoopFuture<GetServiceGraphResult>

  • Get an aggregation of service statistics defined by a specific time range.

    Declaration

    Swift

    public func getTimeSeriesServiceStatistics(_ input: GetTimeSeriesServiceStatisticsRequest) -> EventLoopFuture<GetTimeSeriesServiceStatisticsResult>

  • Retrieves a service graph for one or more specific trace IDs.

    Declaration

    Swift

    public func getTraceGraph(_ input: GetTraceGraphRequest) -> EventLoopFuture<GetTraceGraphResult>

  • 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 AWS X-Ray Developer Guide.

    Declaration

    Swift

    public func getTraceSummaries(_ input: GetTraceSummariesRequest) -> EventLoopFuture<GetTraceSummariesResult>

  • Returns a list of tags that are applied to the specified AWS X-Ray group or sampling rule.

    Declaration

    Swift

    public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>

  • Updates the encryption configuration for X-Ray data.

    Declaration

    Swift

    public func putEncryptionConfig(_ input: PutEncryptionConfigRequest) -> EventLoopFuture<PutEncryptionConfigResult>

  • Used by the AWS X-Ray daemon to upload telemetry.

    Declaration

    Swift

    public func putTelemetryRecords(_ input: PutTelemetryRecordsRequest) -> EventLoopFuture<PutTelemetryRecordsResult>

  • 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.

    Declaration

    Swift

    public func putTraceSegments(_ input: PutTraceSegmentsRequest) -> EventLoopFuture<PutTraceSegmentsResult>

  • Applies tags to an existing AWS X-Ray group or sampling rule.

    Declaration

    Swift

    public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>

  • Removes tags from an AWS X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).

    Declaration

    Swift

    public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>

  • Updates a group resource.

    Declaration

    Swift

    public func updateGroup(_ input: UpdateGroupRequest) -> EventLoopFuture<UpdateGroupResult>

  • Modifies a sampling rule’s configuration.

    Declaration

    Swift

    public func updateSamplingRule(_ input: UpdateSamplingRuleRequest) -> EventLoopFuture<UpdateSamplingRuleResult>

Paginators

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum EncryptionStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum EncryptionType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum SamplingStrategyName : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum TimeRangeType : String, CustomStringConvertible, Codable