sqs

Documentation

Overview

Package sqs provides a set of common interfaces and structs for publishing messages to AWS SQS. Implementations in this package also include distributed tracing capabilities by default.

Index

• type API
• type Publisher
  • func New(api API) (Publisher, error)
  • func (p Publisher) Publish(ctx context.Context, msg *sqs.SendMessageInput) (messageID string, err error)

Examples

• Publisher

Types

type API

type API interface {
	SendMessage(ctx context.Context, params *sqs.SendMessageInput, optFns ...func(*sqs.Options)) (*sqs.SendMessageOutput, error)
}

type Publisher

type Publisher struct {
	// contains filtered or unexported fields
}

Publisher is a wrapper with added distributed tracing capabilities.

Example

customResolver := aws.EndpointResolverWithOptionsFunc(func(service, region string, options ...interface{}) (aws.Endpoint, error) {
	if service == sqs.ServiceID && region == "eu-west-1" {
		return aws.Endpoint{
			URL:           "http://localhost:4576",
			SigningRegion: "eu-west-1",
		}, nil
	}
	// returning EndpointNotFoundError will allow the service to fallback to it's default resolution
	return aws.Endpoint{}, &aws.EndpointNotFoundError{}
})

cfg, err := config.LoadDefaultConfig(context.TODO(),
	config.WithRegion("eu-west-1"),
	config.WithEndpointResolverWithOptions(customResolver),
)
if err != nil {
	log.Fatal(err)
}

api := sqs.NewFromConfig(cfg)

pub, err := New(api)
if err != nil {
	log.Fatal(err)
}

msg := &sqs.SendMessageInput{
	MessageBody: aws.String("message body"),
	QueueUrl:    aws.String("http://localhost:4576/queue/foo-queue"),
}

msgID, err := pub.Publish(context.Background(), msg)
if err != nil {
	log.Fatal(err)
}

fmt.Println(msgID)

func New

func New(api API) (Publisher, error)

New creates a new SQS publisher.

func (Publisher) Publish

func (p Publisher) Publish(ctx context.Context, msg *sqs.SendMessageInput) (messageID string, err error)

Publish tries to publish a new message to SQS. It also stores tracing information.