health

package

v1.0.0-dev.191 Latest Latest Go to latest Published: May 15, 2025 License: MIT Imports: 7 Imported by: 0

Details

This section is empty.

This section is empty.

func ConfigAdd(path string)

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

Checker health checker for go driver for oracle.

func NewChecker(db *sql.DB) *Checker

NewChecker returns a new health checker.

func (c *Checker) Check(ctx context.Context) error

Check checks if db server is up.

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

HealthPlugin implements the factory’s Plugin hooks for health checks.

func NewHealthPlugin() *HealthPlugin

NewHealthPlugin constructs the plugin with default Options.

func NewHealthPluginWithConfigPath(path string) (*HealthPlugin, error)

NewHealthPluginWithConfigPath loads Options from a config file.

func NewHealthPluginWithOptions(opts *Options) *HealthPlugin

NewHealthPluginWithOptions constructs the plugin from explicit Options.

func (h *HealthPlugin) InitDB(ctx context.Context, db *sql.DB) error

InitDB is called immediately after sql.OpenDB: it registers the health check.

func (h *HealthPlugin) WrapConnector(ctx context.Context, connector driver.Connector) (driver.Connector, error)

WrapConnector is a no-op: health checks don’t need to wrap the driver.

type Options struct {
	Name        string
	Enabled     bool
	Description string
	Required    bool
}

Options represents a health checker for go driver for oracle options.

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals a given key path into options and returns it.