Skip to content

feat: make Router.enableTracing configurable #338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 23, 2022
Merged

feat: make Router.enableTracing configurable #338

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
878e512
feat: make Router.enableTracing configurable
Skn0tt Jun 21, 2022
2351a82
feat: flip bool to keep things unchanged
Skn0tt Jun 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 23 additions & 9 deletions server/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,16 @@ type Server struct {
doneOnce sync.Once
}

type RouterConfig struct {
DisableTracing bool
}

type Config struct {
HealthPath string `split_words:"true"`
Port int
Host string
TLS nconf.TLSConfig
Router RouterConfig
}

// APIDefinition is used to control lifecycle of the API
Expand Down Expand Up @@ -67,7 +72,9 @@ func NewOpts(log logrus.FieldLogger, api APIDefinition, opts ...Opt) (*Server, e
WithHostAndPort("", defaultPort),
}

return buildServer(log, api, append(defaultOpts, opts...), defaultHealthPath)
return buildServer(log, api, append(defaultOpts, opts...), Config{
HealthPath: defaultHealthPath,
})
}

// New will build a server with the defaults in place
Expand All @@ -85,7 +92,7 @@ func New(log logrus.FieldLogger, config Config, api APIDefinition) (*Server, err
opts = append(opts, WithTLS(tcfg))
}

return buildServer(log, api, opts, config.HealthPath)
return buildServer(log, api, opts, config)
}

func (s *Server) Shutdown(to time.Duration) error {
Expand Down Expand Up @@ -173,25 +180,32 @@ func APIFunc(start func(router.Router) error, stop func(), info APIInfo) APIDefi
}
}

func buildRouter(log logrus.FieldLogger, api APIDefinition, healthPath string) router.Router {
func buildRouter(log logrus.FieldLogger, api APIDefinition, config Config) router.Router {
var healthHandler router.APIHandler
if checker, ok := api.(HealthChecker); ok {
healthHandler = checker.Healthy
}

r := router.New(
log,
router.OptHealthCheck(healthPath, healthHandler),
router.OptEnableTracing(api.Info().Name),
opts := []router.Option{
router.OptHealthCheck(config.HealthPath, healthHandler),
router.OptVersionHeader(api.Info().Name, api.Info().Version),
router.OptRecoverer(),
}

if !config.Router.DisableTracing {
opts = append(opts, router.OptEnableTracing(api.Info().Name))
}

r := router.New(
log,
opts...,
)

return r
}

func buildServer(log logrus.FieldLogger, api APIDefinition, opts []Opt, healthPath string) (*Server, error) {
r := buildRouter(log, api, healthPath)
func buildServer(log logrus.FieldLogger, api APIDefinition, opts []Opt, config Config) (*Server, error) {
r := buildRouter(log, api, config)

if err := api.Start(r); err != nil {
return nil, errors.Wrap(err, "Failed to start API")
Expand Down