cli

Documentation

Index

• type DatabaseOpts
  • func (c *DatabaseOpts) OpenDatabase() (*sql.DB, error)
• type MetricsOpts
  • func (c *MetricsOpts) MaybeStartMetrics()
• type QueueOpts

Types

type DatabaseOpts

type DatabaseOpts struct {
	Database string `` /* 195-byte string literal not displayed */
}

DatabaseOpts holds cli configuration for the database connection.

func (*DatabaseOpts) OpenDatabase

func (c *DatabaseOpts) OpenDatabase() (*sql.DB, error)

OpenDatabase creates a database connection with the provided configuration.

type MetricsOpts

type MetricsOpts struct {
	Metrics     bool `long:"metrics" env:"BORGES_METRICS" description:"expose a metrics endpoint using an HTTP server"`
	MetricsPort int  `long:"metrics-port" env:"BORGES_METRICS_PORT" description:"port to bind metrics to" default:"6062"`
}

MetricsOps holds cli configuration to expose metrics.

func (*MetricsOpts) MaybeStartMetrics

func (c *MetricsOpts) MaybeStartMetrics()

MaybeStartMetrics starts the metrics server if configured.

type QueueOpts

type QueueOpts struct {
	Queue  string `long:"queue" env:"BORGES_QUEUE" default:"borges" description:"queue name"`
	Broker string `long:"broker" env:"BORGES_BROKER" default:"amqp://localhost:5672" description:"broker service URI"`
}

QueueOpts holds cli configuration for the queue.