Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CLI ¶
type CLI struct {
Dev bool `optional:"" short:"d" help:"Run in development mode."`
Show bool `optional:"" short:"s" help:"Show the configuration and exit."`
Graph string `optional:"" short:"g" help:"Output the dependency graph to the specified file."`
Files []string `optional:"" short:"f" help:"Specific configuration files or directories."`
}
CLI is the structure that is used to capture the command line arguments.
type Config ¶
type Config struct {
Logging sallust.Config
Tracing candlelight.Config
Prometheus touchstone.Config
PrometheusHandler touchhttp.Config
Servers Servers
Routes Routes
Auth apiauth.Config
Oker oker.Config
}
Config is the top level configuration for the notus service. Everything is contained in this structure or it will intentially cause a failure.
type HealthPath ¶
type HealthPath string
type HealthServer ¶
type HealthServer struct {
HTTP arrangehttp.ServerConfig
Path HealthPath //`validate:"empty=false"`
}
type MetricsPath ¶
type MetricsPath string
type MetricsServer ¶
type MetricsServer struct {
HTTP arrangehttp.ServerConfig
Path MetricsPath //`validate:"empty=false"`
}
type PprofPathPrefix ¶
type PprofPathPrefix string
type PprofServer ¶
type PprofServer struct {
HTTP arrangehttp.ServerConfig
Path PprofPathPrefix
}
type PrimaryServer ¶
type PrimaryServer struct {
HTTP arrangehttp.ServerConfig
}
type RoutesOut ¶
type RoutesOut struct {
fx.Out
Primary arrangehttp.Option[http.Server] `group:"servers.primary.options"`
Alternate arrangehttp.Option[http.Server] `group:"servers.alternate.options"`
}
type Servers ¶
type Servers struct {
Health HealthServer
Metrics MetricsServer
Pprof PprofServer
Primary PrimaryServer
Alternate PrimaryServer
}
Click to show internal directories.
Click to hide internal directories.