tstune

Documentation

Overview

Package tstune provides the needed resources and interfaces to create and run a tuning program for TimescaleDB.

Index

• Constants
• Variables
• type Tuner
  • func (t *Tuner) Run(flags *TunerFlags, in io.Reader, out io.Writer, outErr io.Writer)
• type TunerFlags

Constants

const (
	// Version is the version of this library
	Version = "0.15.0"
)

Variables

var ValidPGVersions = []string{
	pgutils.MajorVersion16,
	pgutils.MajorVersion15,
	pgutils.MajorVersion14,
	pgutils.MajorVersion13,
	pgutils.MajorVersion12,
	pgutils.MajorVersion11,
	pgutils.MajorVersion10,
	pgutils.MajorVersion96,
}

ValidPGVersions is a slice representing the major versions of PostgreSQL for which recommendations can be generated.

Types

type Tuner

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

Tuner represents the tuning program for TimescaleDB.

func (*Tuner) Run

func (t *Tuner) Run(flags *TunerFlags, in io.Reader, out io.Writer, outErr io.Writer)

Run executes the tuning process given the provided flags and looks for input on the in io.Reader. Informational messages are written to outErr while actual recommendations are written to out.

type TunerFlags

type TunerFlags struct {
	Memory       string // amount of memory to base recommendations on
	NumCPUs      uint   // number of CPUs to base recommendations on
	WALDiskSize  string // disk size of WAL to base recommendations on
	PGVersion    string // major version of PostgreSQL to base recommendations on
	PGConfig     string // path to pg_config binary
	MaxConns     uint64 // max number of database connections
	MaxBGWorkers int    // max number of background workers
	ConfPath     string // path to the postgresql.conf file
	DestPath     string // path to output file
	YesAlways    bool   // always respond yes to prompts
	Quiet        bool   // show only the bare necessities
	UseColor     bool   // use color in output
	DryRun       bool   // whether to actually persist changes to disk
	Restore      bool   // whether to restore a backup
	Profile      string // a specific "mode" to provide recommendations tailored to a special workload type, e.g. "promscale"
}

TunerFlags are the flags that control how a Tuner object behaves when it is run.