redis

Documentation

Index

• Variables
• func NewRedisClient(cfg *RedisOptions) *redis.Client
• func NewRedisHealthChecker(client *redis.Client) contracts.Health
• type RedisHealthChecker
  • func (healthChecker *RedisHealthChecker) CheckHealth(ctx context.Context) error
  • func (healthChecker *RedisHealthChecker) GetHealthName() string
• type RedisOptions

Variables

var (
	// Module provided to fxlog
	// https://uber-go.github.io/fx/modules.html
	Module = fx.Module(
		"redisfx",
		redisProviders,
		redisInvokes,
	) //nolint:gochecknoglobals

)

Functions

func NewRedisClient

func NewRedisClient(cfg *RedisOptions) *redis.Client

func NewRedisHealthChecker

func NewRedisHealthChecker(client *redis.Client) contracts.Health

Types

type RedisHealthChecker

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

func (*RedisHealthChecker) CheckHealth

func (healthChecker *RedisHealthChecker) CheckHealth(ctx context.Context) error

func (*RedisHealthChecker) GetHealthName

func (healthChecker *RedisHealthChecker) GetHealthName() string

type RedisOptions

type RedisOptions struct {
	Host          string `mapstructure:"host"`
	Port          int    `mapstructure:"port"`
	Password      string `mapstructure:"password"`
	Database      int    `mapstructure:"database"`
	PoolSize      int    `mapstructure:"poolSize"`
	EnableTracing bool   `mapstructure:"enableTracing" default:"true"`
}