stat

package module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 17, 2025 License: Apache-2.0 Imports: 9 Imported by: 0

README

sqsmessageconsumer - An implementation of sqsmessageconsumer that adds stats

GoDoc

Bugs Code Smells Coverage Lines of Code Maintainability Rating Quality Gate Status Reliability Rating Security Rating Technical Debt Vulnerabilities

Build Status codecov.io

Contributing

License

This project is licensed under Apache 2.0. See LICENSE.txt for details.

Contributing Agreement

Atlassian requires signing a contributor's agreement before we can accept a patch. If you are an individual you can fill out the individual CLA. If you are contributing on behalf of your company then please fill out the corporate CLA.

Documentation

Overview

Package stat is a generated GoMock package.

Package stat is a generated GoMock package.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewStatBinder 

func NewStatBinder(stats xstats.XStater) func(runsqs.SQSMessageConsumer) runsqs.SQSMessageConsumer

NewStatBinder returns a function that wraps a `runsqs.SQSMessageConsumer` in a `Binder` `runsqs.SQSMessageConsumer`.

func NewStatMessageConsumer 

func NewStatMessageConsumer() func(runsqs.SQSMessageConsumer) runsqs.SQSMessageConsumer

NewStatMessageConsumer returns a function that wraps a `runsqs.SQSMessageConsumer` in a `MessageConsumer` `runsqs.SQSMessageConsumer`.

Types

type Binder added in v0.4.0 

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

Binder is a `SQSMessageConsumer` decorator that injects an `xstats.XStater` into the `context.Context` of the given `context`.

The `Binder` can then, in turn, be decorated with a `SQSMessageConsumer` to make use of the injected `xstats.XStater` to emit key HTTP metrics on each v.

func (*Binder) ConsumeMessage added in v0.4.0 

func (t *Binder) ConsumeMessage(ctx context.Context, message *types.Message) runsqs.SQSMessageConsumerError

ConsumeMessage injects an `xstats.XStater` into the context and invokes the wrapped `SQSMessageConsumer`.

func (*Binder) DeadLetter added in v0.4.0 

func (t *Binder) DeadLetter(ctx context.Context, message *types.Message)

DeadLetter injects an `xstats.XStater` into the context and invokes the wrapped `SQSMessageConsumer`.

type MessageConsumer added in v0.4.0 

type MessageConsumer struct {
	ConsumedCounter           string
	ConsumerSuccessCounter    string
	ConsumerErrorCounter      string
	ConsumedSize              string
	ConsumerLag               string
	ConsumerTimingSuccess     string
	ConsumerTimingFailure     string
	ConsumerDeadLetterCounter string
	// contains filtered or unexported fields
}

MessageConsumer a is wrapper around runsqs.SQSMessageConsumer to capture and emit SQS related stats

func (MessageConsumer) ConsumeMessage added in v0.4.0 

func (t MessageConsumer) ConsumeMessage(ctx context.Context, message *types.Message) runsqs.SQSMessageConsumerError

ConsumeMessage pulls an `xstats.XStater` from the context, performs stats around message consumption and invokes the wrapped `SQSMessageConsumer.ConsumeMessage`.

func (MessageConsumer) DeadLetter added in v0.4.0 

func (t MessageConsumer) DeadLetter(ctx context.Context, message *types.Message)

DeadLetter pulls an `xstats.XStater` from the context, performs stats around message dead lettering and invokes the wrapped `SQSMessageConsumer.DeadLetter`.

type MessageConsumerComponent added in v0.4.0 

type MessageConsumerComponent struct{}

MessageConsumerComponent implements the settings.Component interface.

func NewComponent 

func NewComponent() *MessageConsumerComponent

NewComponent populates default values.

func (*MessageConsumerComponent) New added in v0.4.0 

func (c *MessageConsumerComponent) New(_ context.Context, conf *MessageConsumerConfig) (func(runsqs.SQSMessageConsumer) runsqs.SQSMessageConsumer, error)

func (*MessageConsumerComponent) Settings added in v0.4.0 

func (*MessageConsumerComponent) Settings() *MessageConsumerConfig

Settings generates a config populated with defaults.

type MessageConsumerConfig added in v0.4.0 

type MessageConsumerConfig struct {
	ConsumedCounter           string `description:"Name of overall sqs record consumption metric."`
	ConsumerSuccessCounter    string `description:"Name of overall successful sqs message consumption metric."`
	ConsumerErrorCounter      string `description:"Name of overall failed sqs message consumption metric."`
	ConsumedSize              string `description:"Name of consumed sqs message size metric."`
	ConsumerLag               string `description:"Name of lag time between sqs production and consumption metric."`
	ConsumerTimingSuccess     string `description:"Name of time to process successful sqs message metric."`
	ConsumerTimingFailure     string `description:"Name of time to process failed sqs message metric."`
	ConsumerDeadLetterCounter string `description:"Name of overall dead lettered sqs messages metric."`
}

MessageConsumerConfig is the config for creating a MessageConsumer

func (*MessageConsumerConfig) Name added in v0.4.0 

func (*MessageConsumerConfig) Name() string

Name of the config root.

type MockCopier added in v1.0.0 

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

MockCopier is a mock of Copier interface.

func NewMockCopier added in v1.0.0 

func NewMockCopier(ctrl *gomock.Controller) *MockCopier

NewMockCopier creates a new mock instance.

func (*MockCopier) Copy added in v1.0.0 

func (m *MockCopier) Copy() xstats.XStater

Copy mocks base method.

func (*MockCopier) EXPECT added in v1.0.0 

func (m *MockCopier) EXPECT() *MockCopierMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

type MockCopierMockRecorder added in v1.0.0 

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

MockCopierMockRecorder is the mock recorder for MockCopier.

func (*MockCopierMockRecorder) Copy added in v1.0.0 

func (mr *MockCopierMockRecorder) Copy() *gomock.Call

Copy indicates an expected call of Copy.

type MockSQSClient added in v1.0.0 

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

MockSQSClient is a mock of SQSClient interface.

func NewMockSQSClient added in v1.0.0 

func NewMockSQSClient(ctrl *gomock.Controller) *MockSQSClient

NewMockSQSClient creates a new mock instance.

func (*MockSQSClient) ChangeMessageVisibility added in v1.0.0 

func (m *MockSQSClient) ChangeMessageVisibility(ctx context.Context, params *sqs.ChangeMessageVisibilityInput, optFns ...func(*sqs.Options)) (*sqs.ChangeMessageVisibilityOutput, error)

ChangeMessageVisibility mocks base method.

func (*MockSQSClient) DeleteMessage added in v1.0.0 

func (m *MockSQSClient) DeleteMessage(ctx context.Context, params *sqs.DeleteMessageInput, optFns ...func(*sqs.Options)) (*sqs.DeleteMessageOutput, error)

DeleteMessage mocks base method.

func (*MockSQSClient) EXPECT added in v1.0.0 

func (m *MockSQSClient) EXPECT() *MockSQSClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockSQSClient) ReceiveMessage added in v1.0.0 

func (m *MockSQSClient) ReceiveMessage(ctx context.Context, params *sqs.ReceiveMessageInput, optFns ...func(*sqs.Options)) (*sqs.ReceiveMessageOutput, error)

ReceiveMessage mocks base method.

func (*MockSQSClient) SendMessage added in v1.0.0 

func (m *MockSQSClient) SendMessage(ctx context.Context, params *sqs.SendMessageInput, optFns ...func(*sqs.Options)) (*sqs.SendMessageOutput, error)

SendMessage mocks base method.

func (*MockSQSClient) SendMessageBatch added in v1.0.0 

func (m *MockSQSClient) SendMessageBatch(ctx context.Context, params *sqs.SendMessageBatchInput, optFns ...func(*sqs.Options)) (*sqs.SendMessageBatchOutput, error)

SendMessageBatch mocks base method.

type MockSQSClientMockRecorder added in v1.0.0 

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

MockSQSClientMockRecorder is the mock recorder for MockSQSClient.

func (*MockSQSClientMockRecorder) ChangeMessageVisibility added in v1.0.0 

func (mr *MockSQSClientMockRecorder) ChangeMessageVisibility(ctx, params any, optFns ...any) *gomock.Call

ChangeMessageVisibility indicates an expected call of ChangeMessageVisibility.

func (*MockSQSClientMockRecorder) DeleteMessage added in v1.0.0 

func (mr *MockSQSClientMockRecorder) DeleteMessage(ctx, params any, optFns ...any) *gomock.Call

DeleteMessage indicates an expected call of DeleteMessage.

func (*MockSQSClientMockRecorder) ReceiveMessage added in v1.0.0 

func (mr *MockSQSClientMockRecorder) ReceiveMessage(ctx, params any, optFns ...any) *gomock.Call

ReceiveMessage indicates an expected call of ReceiveMessage.

func (*MockSQSClientMockRecorder) SendMessage added in v1.0.0 

func (mr *MockSQSClientMockRecorder) SendMessage(ctx, params any, optFns ...any) *gomock.Call

SendMessage indicates an expected call of SendMessage.

func (*MockSQSClientMockRecorder) SendMessageBatch added in v1.0.0 

func (mr *MockSQSClientMockRecorder) SendMessageBatch(ctx, params any, optFns ...any) *gomock.Call

SendMessageBatch indicates an expected call of SendMessageBatch.

type MockSQSConsumer 

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

MockSQSConsumer is a mock of SQSConsumer interface.

func NewMockSQSConsumer 

func NewMockSQSConsumer(ctrl *gomock.Controller) *MockSQSConsumer

NewMockSQSConsumer creates a new mock instance.

func (*MockSQSConsumer) EXPECT 

func (m *MockSQSConsumer) EXPECT() *MockSQSConsumerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockSQSConsumer) GetSQSMessageConsumer 

func (m *MockSQSConsumer) GetSQSMessageConsumer() v4.SQSMessageConsumer

GetSQSMessageConsumer mocks base method.

func (*MockSQSConsumer) StartConsuming 

func (m *MockSQSConsumer) StartConsuming(ctx context.Context) error

StartConsuming mocks base method.

func (*MockSQSConsumer) StopConsuming 

func (m *MockSQSConsumer) StopConsuming(ctx context.Context) error

StopConsuming mocks base method.

type MockSQSConsumerMockRecorder 

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

MockSQSConsumerMockRecorder is the mock recorder for MockSQSConsumer.

func (*MockSQSConsumerMockRecorder) GetSQSMessageConsumer 

func (mr *MockSQSConsumerMockRecorder) GetSQSMessageConsumer() *gomock.Call

GetSQSMessageConsumer indicates an expected call of GetSQSMessageConsumer.

func (*MockSQSConsumerMockRecorder) StartConsuming 

func (mr *MockSQSConsumerMockRecorder) StartConsuming(ctx any) *gomock.Call

StartConsuming indicates an expected call of StartConsuming.

func (*MockSQSConsumerMockRecorder) StopConsuming 

func (mr *MockSQSConsumerMockRecorder) StopConsuming(ctx any) *gomock.Call

StopConsuming indicates an expected call of StopConsuming.

type MockSQSMessageConsumer 

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

MockSQSMessageConsumer is a mock of SQSMessageConsumer interface.

func NewMockSQSMessageConsumer 

func NewMockSQSMessageConsumer(ctrl *gomock.Controller) *MockSQSMessageConsumer

NewMockSQSMessageConsumer creates a new mock instance.

func (*MockSQSMessageConsumer) ConsumeMessage 

func (m *MockSQSMessageConsumer) ConsumeMessage(ctx context.Context, message *types.Message) v4.SQSMessageConsumerError

ConsumeMessage mocks base method.

func (*MockSQSMessageConsumer) DeadLetter added in v0.2.0 

func (m *MockSQSMessageConsumer) DeadLetter(ctx context.Context, message *types.Message)

DeadLetter mocks base method.

func (*MockSQSMessageConsumer) EXPECT 

func (m *MockSQSMessageConsumer) EXPECT() *MockSQSMessageConsumerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

type MockSQSMessageConsumerError added in v0.1.0 

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

MockSQSMessageConsumerError is a mock of SQSMessageConsumerError interface.

func NewMockSQSMessageConsumerError added in v0.1.0 

func NewMockSQSMessageConsumerError(ctrl *gomock.Controller) *MockSQSMessageConsumerError

NewMockSQSMessageConsumerError creates a new mock instance.

func (*MockSQSMessageConsumerError) EXPECT added in v0.1.0 

func (m *MockSQSMessageConsumerError) EXPECT() *MockSQSMessageConsumerErrorMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockSQSMessageConsumerError) Error added in v0.1.0 

func (m *MockSQSMessageConsumerError) Error() string

Error mocks base method.

func (*MockSQSMessageConsumerError) IsRetryable added in v0.1.0 

func (m *MockSQSMessageConsumerError) IsRetryable() bool

IsRetryable mocks base method.

func (*MockSQSMessageConsumerError) RetryAfter added in v0.1.0 

func (m *MockSQSMessageConsumerError) RetryAfter() int32

RetryAfter mocks base method.

type MockSQSMessageConsumerErrorMockRecorder added in v0.1.0 

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

MockSQSMessageConsumerErrorMockRecorder is the mock recorder for MockSQSMessageConsumerError.

func (*MockSQSMessageConsumerErrorMockRecorder) Error added in v0.1.0 

func (mr *MockSQSMessageConsumerErrorMockRecorder) Error() *gomock.Call

Error indicates an expected call of Error.

func (*MockSQSMessageConsumerErrorMockRecorder) IsRetryable added in v0.1.0 

func (mr *MockSQSMessageConsumerErrorMockRecorder) IsRetryable() *gomock.Call

IsRetryable indicates an expected call of IsRetryable.

func (*MockSQSMessageConsumerErrorMockRecorder) RetryAfter added in v0.1.0 

func (mr *MockSQSMessageConsumerErrorMockRecorder) RetryAfter() *gomock.Call

RetryAfter indicates an expected call of RetryAfter.

type MockSQSMessageConsumerMockRecorder 

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

MockSQSMessageConsumerMockRecorder is the mock recorder for MockSQSMessageConsumer.

func (*MockSQSMessageConsumerMockRecorder) ConsumeMessage 

func (mr *MockSQSMessageConsumerMockRecorder) ConsumeMessage(ctx, message any) *gomock.Call

ConsumeMessage indicates an expected call of ConsumeMessage.

func (*MockSQSMessageConsumerMockRecorder) DeadLetter added in v0.2.0 

func (mr *MockSQSMessageConsumerMockRecorder) DeadLetter(ctx, message any) *gomock.Call

DeadLetter indicates an expected call of DeadLetter.

type MockSQSProducer 

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

MockSQSProducer is a mock of SQSProducer interface.

func NewMockSQSProducer 

func NewMockSQSProducer(ctrl *gomock.Controller) *MockSQSProducer

NewMockSQSProducer creates a new mock instance.

func (*MockSQSProducer) BatchProduceMessage added in v1.0.0 

func (m *MockSQSProducer) BatchProduceMessage(ctx context.Context, messageBatchInput *sqs.SendMessageBatchInput) (*sqs.SendMessageBatchOutput, error)

BatchProduceMessage mocks base method.

func (*MockSQSProducer) EXPECT 

func (m *MockSQSProducer) EXPECT() *MockSQSProducerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockSQSProducer) ProduceMessage 

func (m *MockSQSProducer) ProduceMessage(ctx context.Context, messageInput *sqs.SendMessageInput) error

ProduceMessage mocks base method.

func (*MockSQSProducer) QueueURL added in v0.3.0 

func (m *MockSQSProducer) QueueURL() string

QueueURL mocks base method.

type MockSQSProducerMockRecorder 

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

MockSQSProducerMockRecorder is the mock recorder for MockSQSProducer.

func (*MockSQSProducerMockRecorder) BatchProduceMessage added in v1.0.0 

func (mr *MockSQSProducerMockRecorder) BatchProduceMessage(ctx, messageBatchInput any) *gomock.Call

BatchProduceMessage indicates an expected call of BatchProduceMessage.

func (*MockSQSProducerMockRecorder) ProduceMessage 

func (mr *MockSQSProducerMockRecorder) ProduceMessage(ctx, messageInput any) *gomock.Call

ProduceMessage indicates an expected call of ProduceMessage.

func (*MockSQSProducerMockRecorder) QueueURL added in v0.3.0 

func (mr *MockSQSProducerMockRecorder) QueueURL() *gomock.Call

QueueURL indicates an expected call of QueueURL.

type MockScoper added in v1.0.0 

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

MockScoper is a mock of Scoper interface.

func NewMockScoper added in v1.0.0 

func NewMockScoper(ctrl *gomock.Controller) *MockScoper

NewMockScoper creates a new mock instance.

func (*MockScoper) EXPECT added in v1.0.0 

func (m *MockScoper) EXPECT() *MockScoperMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockScoper) Scope added in v1.0.0 

func (m *MockScoper) Scope(scope string, scopes ...string) xstats.XStater

Scope mocks base method.

type MockScoperMockRecorder added in v1.0.0 

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

MockScoperMockRecorder is the mock recorder for MockScoper.

func (*MockScoperMockRecorder) Scope added in v1.0.0 

func (mr *MockScoperMockRecorder) Scope(scope any, scopes ...any) *gomock.Call

Scope indicates an expected call of Scope.

type MockXStater added in v1.0.0 

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

MockXStater is a mock of XStater interface.

func NewMockXStater added in v1.0.0 

func NewMockXStater(ctrl *gomock.Controller) *MockXStater

NewMockXStater creates a new mock instance.

func (*MockXStater) AddTags added in v1.0.0 

func (m *MockXStater) AddTags(tags ...string)

AddTags mocks base method.

func (*MockXStater) Count added in v1.0.0 

func (m *MockXStater) Count(stat string, count float64, tags ...string)

Count mocks base method.

func (*MockXStater) EXPECT added in v1.0.0 

func (m *MockXStater) EXPECT() *MockXStaterMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockXStater) Gauge added in v1.0.0 

func (m *MockXStater) Gauge(stat string, value float64, tags ...string)

Gauge mocks base method.

func (*MockXStater) GetTags added in v1.0.0 

func (m *MockXStater) GetTags() []string

GetTags mocks base method.

func (*MockXStater) Histogram added in v1.0.0 

func (m *MockXStater) Histogram(stat string, value float64, tags ...string)

Histogram mocks base method.

func (*MockXStater) Timing added in v1.0.0 

func (m *MockXStater) Timing(stat string, value time.Duration, tags ...string)

Timing mocks base method.

type MockXStaterMockRecorder added in v1.0.0 

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

MockXStaterMockRecorder is the mock recorder for MockXStater.

func (*MockXStaterMockRecorder) AddTags added in v1.0.0 

func (mr *MockXStaterMockRecorder) AddTags(tags ...any) *gomock.Call

AddTags indicates an expected call of AddTags.

func (*MockXStaterMockRecorder) Count added in v1.0.0 

func (mr *MockXStaterMockRecorder) Count(stat, count any, tags ...any) *gomock.Call

Count indicates an expected call of Count.

func (*MockXStaterMockRecorder) Gauge added in v1.0.0 

func (mr *MockXStaterMockRecorder) Gauge(stat, value any, tags ...any) *gomock.Call

Gauge indicates an expected call of Gauge.

func (*MockXStaterMockRecorder) GetTags added in v1.0.0 

func (mr *MockXStaterMockRecorder) GetTags() *gomock.Call

GetTags indicates an expected call of GetTags.

func (*MockXStaterMockRecorder) Histogram added in v1.0.0 

func (mr *MockXStaterMockRecorder) Histogram(stat, value any, tags ...any) *gomock.Call

Histogram indicates an expected call of Histogram.

func (*MockXStaterMockRecorder) Timing added in v1.0.0 

func (mr *MockXStaterMockRecorder) Timing(stat, value any, tags ...any) *gomock.Call

Timing indicates an expected call of Timing.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.