claimcheck

Documentation

Index

• func InitMetrics(registry *prometheus.Registry)
• func NewFileName() string
• type ClaimCheck
  • func New(ctx context.Context, config *config.LargeMessageHandleConfig, ...) (*ClaimCheck, error)
  • func (c *ClaimCheck) CleanMetrics()
  • func (c *ClaimCheck) FileNameWithPrefix(fileName string) string
  • func (c *ClaimCheck) WriteMessage(ctx context.Context, key, value []byte, fileName string) (err error)

Functions

func InitMetrics

func InitMetrics(registry *prometheus.Registry)

InitMetrics registers all claim check related metrics

func NewFileName

func NewFileName() string

NewFileName return the file name for the message which is delivered to the external storage system. UUID V4 is used to generate random and unique file names. This should not exceed the S3 object name length limit. ref https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html

Types

type ClaimCheck

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

ClaimCheck manage send message to the claim-check external storage.

func New

func New(ctx context.Context, config *config.LargeMessageHandleConfig, changefeedID model.ChangeFeedID) (*ClaimCheck, error)

New return a new ClaimCheck.

func (*ClaimCheck) CleanMetrics

func (c *ClaimCheck) CleanMetrics()

CleanMetrics the claim check by clean up the metrics.

func (*ClaimCheck) FileNameWithPrefix

func (c *ClaimCheck) FileNameWithPrefix(fileName string) string

FileNameWithPrefix returns the file name with prefix, the full path.

func (*ClaimCheck) WriteMessage

func (c *ClaimCheck) WriteMessage(ctx context.Context, key, value []byte, fileName string) (err error)

WriteMessage write message to the claim check external storage.