Overview ▹

Overview ▾

Package xray provides the client and types for making API requests to AWS X-Ray.

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

See https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12 for more information on this service.

See xray package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/xray/

Using the Client

To use the client for AWS X-Ray you will first need to create a new instance of it.

When creating a client for an AWS service you'll first need to have a Session already created. The Session provides configuration that can be shared between multiple service clients. Additional configuration can be applied to the Session and service's client when they are constructed. The aws package's Config type contains several fields such as Region for the AWS Region the client should make API requests too. The optional Config value can be provided as the variadic argument for Sessions and client creation.

Once the service's client is created you can use it to make API requests the AWS service. These clients are safe to use concurrently.

// Create a session to share configuration, and load external configuration.
sess := session.Must(session.NewSession())

// Create the service's client with the session.
svc := xray.New(sess)

See the SDK's documentation for more information on how to use service clients. https://docs.aws.amazon.com/sdk-for-go/api/

See aws package's Config type for more information on configuration options. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS X-Ray client XRay for more information on creating the service's client. https://docs.aws.amazon.com/sdk-for-go/api/service/xray/#New

Once the client is created you can make an API request to the service. Each API method takes a input parameter, and returns the service response and an error.

The API method will document which error codes the service can be returned by the operation if the service models the API operation's errors. These errors will also be available as const strings prefixed with "ErrCode".

result, err := svc.BatchGetTraces(params)
if err != nil {
    // Cast err to awserr.Error to handle specific error codes.
    aerr, ok := err.(awserr.Error)
    if ok && aerr.Code() == <error code to check for> {
        // Specific error code handling
    }
    return err
}

fmt.Println("BatchGetTraces result:")
fmt.Println(result)

Using the Client with Context

The service's client also provides methods to make API requests with a Context value. This allows you to control the timeout, and cancellation of pending requests. These methods also take request Option as variadic parameter to apply additional configuration to the API request.

ctx := context.Background()

result, err := svc.BatchGetTracesWithContext(ctx, params)

See the request package documentation for more information on using Context pattern with the SDK. https://docs.aws.amazon.com/sdk-for-go/api/aws/request/

Name	Synopsis
..
xrayiface	Package xrayiface provides an interface to enable mocking the AWS X-Ray service client for testing your code.

Package xray

Overview ▹

Overview ▾

Using the Client

Using the Client with Context

Index ▹

Index ▾

Package files

Internal call graph ▹

Internal call graph ▾

Constants

type Alias ¶

func (Alias) GoString ¶

func (*Alias) SetName ¶

func (*Alias) SetNames ¶

func (*Alias) SetType ¶

func (Alias) String ¶

type AnnotationValue ¶

func (AnnotationValue) GoString ¶

func (*AnnotationValue) SetBooleanValue ¶

func (*AnnotationValue) SetNumberValue ¶

func (*AnnotationValue) SetStringValue ¶

func (AnnotationValue) String ¶

type BackendConnectionErrors ¶

func (BackendConnectionErrors) GoString ¶

func (*BackendConnectionErrors) SetConnectionRefusedCount ¶

func (*BackendConnectionErrors) SetHTTPCode4XXCount ¶

func (*BackendConnectionErrors) SetHTTPCode5XXCount ¶

func (*BackendConnectionErrors) SetOtherCount ¶

func (*BackendConnectionErrors) SetTimeoutCount ¶

func (*BackendConnectionErrors) SetUnknownHostCount ¶

func (BackendConnectionErrors) String ¶

type BatchGetTracesInput ¶

func (BatchGetTracesInput) GoString ¶

func (*BatchGetTracesInput) SetNextToken ¶

func (*BatchGetTracesInput) SetTraceIds ¶

func (BatchGetTracesInput) String ¶

func (*BatchGetTracesInput) Validate ¶

type BatchGetTracesOutput ¶

func (BatchGetTracesOutput) GoString ¶

func (*BatchGetTracesOutput) SetNextToken ¶

func (*BatchGetTracesOutput) SetTraces ¶

func (*BatchGetTracesOutput) SetUnprocessedTraceIds ¶

func (BatchGetTracesOutput) String ¶

type Edge ¶

func (Edge) GoString ¶

func (*Edge) SetAliases ¶

func (*Edge) SetEndTime ¶

func (*Edge) SetReferenceId ¶

func (*Edge) SetResponseTimeHistogram ¶

func (*Edge) SetStartTime ¶

func (*Edge) SetSummaryStatistics ¶

func (Edge) String ¶

type EdgeStatistics ¶

func (EdgeStatistics) GoString ¶

func (*EdgeStatistics) SetErrorStatistics ¶

func (*EdgeStatistics) SetFaultStatistics ¶

func (*EdgeStatistics) SetOkCount ¶

func (*EdgeStatistics) SetTotalCount ¶

func (*EdgeStatistics) SetTotalResponseTime ¶

func (EdgeStatistics) String ¶

type ErrorStatistics ¶

func (ErrorStatistics) GoString ¶

func (*ErrorStatistics) SetOtherCount ¶

func (*ErrorStatistics) SetThrottleCount ¶

func (*ErrorStatistics) SetTotalCount ¶

func (ErrorStatistics) String ¶

type FaultStatistics ¶

func (FaultStatistics) GoString ¶

func (*FaultStatistics) SetOtherCount ¶

func (*FaultStatistics) SetTotalCount ¶

func (FaultStatistics) String ¶

type GetServiceGraphInput ¶

func (GetServiceGraphInput) GoString ¶

func (*GetServiceGraphInput) SetEndTime ¶

func (*GetServiceGraphInput) SetNextToken ¶

func (*GetServiceGraphInput) SetStartTime ¶

func (GetServiceGraphInput) String ¶

func (*GetServiceGraphInput) Validate ¶

type GetServiceGraphOutput ¶