Skip to content

feat: improve HTTP API logging, honor no-startup-message #1091

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
piksel merged 5 commits into from
Nov 29, 2021
Merged

feat: improve HTTP API logging, honor no-startup-message #1091

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2f5aede
Move HTTP API startup logging to be affected by --no-startup-message
jinnatar Oct 23, 2021
4301180
Show startup messages also when running in non-polling API mode
jinnatar Oct 23, 2021
9f0eee6
Update startup logging to be more accurate for a disabled scheduler.
jinnatar Oct 23, 2021
57987ae
Drop useless debug logging when starting HTTP endpoint
jinnatar Oct 25, 2021
ac8ad56
Make --run-once startup message more helpful, avoid code duplication
jinnatar Oct 25, 2021
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
15 changes: 14 additions & 1 deletion cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,11 @@ func Run(c *cobra.Command, names []string) {
if enableUpdateAPI {
updateHandler := update.New(func() { runUpdatesWithNotifications(filter) }, updateLock)
httpAPI.RegisterFunc(updateHandler.Path, updateHandler.Handle)
// If polling isn't enabled the scheduler is never started and
// we need to trigger the startup messages manually.
if !unblockHTTPAPI {
writeStartupMessage(c, time.Time{}, filterDesc)
}
}

if enableMetricsAPI {
Expand Down Expand Up @@ -261,6 +266,7 @@ func formatDuration(d time.Duration) string {

func writeStartupMessage(c *cobra.Command, sched time.Time, filtering string) {
noStartupMessage, _ := c.PersistentFlags().GetBool("no-startup-message")
enableUpdateAPI, _ := c.PersistentFlags().GetBool("http-api-update")

var startupLog *log.Entry
if noStartupMessage {
Expand All @@ -286,8 +292,15 @@ func writeStartupMessage(c *cobra.Command, sched time.Time, filtering string) {
until := formatDuration(time.Until(sched))
startupLog.Info("Scheduling first run: " + sched.Format("2006-01-02 15:04:05 -0700 MST"))
startupLog.Info("Note that the first check will be performed in " + until)
} else if runOnce, _ := c.PersistentFlags().GetBool("run-once"); runOnce {
startupLog.Info("Running a one time update.")
} else {
startupLog.Info("Running a one time update.")
startupLog.Info("Periodic runs are not enabled.")
}

if enableUpdateAPI {
// TODO: make listen port configurable
startupLog.Info("The HTTP API is enabled at :8080.")
}

if !noStartupMessage {
Expand Down
2 changes: 0 additions & 2 deletions pkg/api/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ func (api *API) Start(block bool) error {
log.Fatal(tokenMissingMsg)
}

log.Info("Watchtower HTTP API started.")
if block {
runHTTPServer()
} else {
Expand All @@ -71,6 +70,5 @@ func (api *API) Start(block bool) error {
}

func runHTTPServer() {
log.Info("Serving HTTP")
log.Fatal(http.ListenAndServe(":8080", nil))
}