sqs

package module

v6.0.0-beta.5 Latest Latest Go to latest Published: May 9, 2026 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/roadrunner-server/sqs

Links

Open Source Insights

README ¶

Docs: link

Documentation ¶

Overview ¶

Package sqs provides a RoadRunner jobs driver for AWS SQS queues.

The plugin registers itself under the "sqs" name and implements the Endure service container lifecycle (Init, Collects). It reads connection credentials and queue settings from the application configuration and produces jobs.Driver instances via DriverFromConfig and DriverFromPipeline.

OpenTelemetry tracing is supported: when a TracerProvider is collected through dependency injection, every driver created by the plugin propagates trace context across SQS messages.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Configurer ¶

type Configurer interface {
	// UnmarshalKey takes a single key and unmarshal it into a Struct.
	UnmarshalKey(name string, out any) error
	// Has checks if a config section exists.
	Has(name string) bool
}

type Logger ¶

type Logger interface {
	NamedLogger(name string) *slog.Logger
}

type Plugin ¶

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

func (*Plugin) Collects ¶

func (p *Plugin) Collects() []*dep.In

func (*Plugin) DriverFromConfig ¶

func (p *Plugin) DriverFromConfig(ctx context.Context, configKey string, pq jobs.Queue, pipeline jobs.Pipeline) (jobs.Driver, error)

func (*Plugin) DriverFromPipeline ¶

func (p *Plugin) DriverFromPipeline(ctx context.Context, pipe jobs.Pipeline, pq jobs.Queue) (jobs.Driver, error)

func (*Plugin) Init ¶

func (p *Plugin) Init(log Logger, cfg Configurer) error

func (*Plugin) Name ¶

func (p *Plugin) Name() string

type Tracer ¶

type Tracer interface {
	Tracer() *sdktrace.TracerProvider
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
sqsjobs Package sqsjobs implements the core AWS SQS jobs driver for RoadRunner.	Package sqsjobs implements the core AWS SQS jobs driver for RoadRunner.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL