mongo

Documentation

Index

• func New(config Config) func(ctx context.Context) error
• type Config

Functions

func New

func New(config Config) func(ctx context.Context) error

New creates new MongoDB health check that verifies the following: - connection establishing - doing the ping command

Types

type Config

type Config struct {
	// DSN is the MongoDB instance connection DSN. Required.
	DSN string

	// TimeoutConnect defines timeout for establishing mongo connection, if not set - default value is used
	TimeoutConnect time.Duration
	// TimeoutDisconnect defines timeout for closing connection, if not set - default value is used
	TimeoutDisconnect time.Duration
	// TimeoutDisconnect defines timeout for making ping request, if not set - default value is used
	TimeoutPing time.Duration
}

Config is the MongoDB checker configuration settings container.