Merge pull request #679 from jmpsec/display-build-metadata

Display build metadata on service start

Author: javuto

cmd/admin/main.go

@@ -39,8 +39,6 @@ const (
 	projectName string = "osctrl"
 	// Service name
 	serviceName string = projectName + "-" + config.ServiceAdmin
-	// Service version
-	serviceVersion string = version.OsctrlVersion
 	// Service description
 	serviceDescription string = "Admin service for osctrl"
 	// Application description
@@ -75,7 +73,7 @@ const (
 
 // Build-time metadata (overridden via -ldflags "-X main.buildVersion=... -X main.buildCommit=... -X main.buildDate=...")
 var (
-	buildVersion = serviceVersion
+	buildVersion = version.OsctrlVersion
 	buildCommit  = "unknown"
 	buildDate    = "unknown"
 )
@@ -304,7 +302,7 @@ func osctrlAdminService() {
 		handlers.WithSettings(settingsmgr),
 		handlers.WithCache(redis),
 		handlers.WithSessions(sessionsmgr),
-		handlers.WithVersion(serviceVersion),
+		handlers.WithVersion(buildVersion),
 		handlers.WithOsqueryVersion(flagParams.OsqueryVersion),
 		handlers.WithTemplates(flagParams.TemplatesDir),
 		handlers.WithStaticLocation(flagParams.StaticOffline),
@@ -555,14 +553,16 @@ func osctrlAdminService() {
 			TLSConfig:    cfg,
 			TLSNextProto: make(map[string]func(*http.Server, *tls.Conn, http.Handler), 0),
 		}
-		log.Info().Msgf("%s v%s - HTTPS listening %s", serviceName, serviceVersion, serviceListener)
+		log.Info().Msgf("%s v%s - HTTPS listening %s", serviceName, buildVersion, serviceListener)
+		log.Info().Msgf("%s - commit=%s - build date=%s", serviceName, buildCommit, buildDate)
 		if err := srv.ListenAndServeTLS(flagParams.TLSCertFile, flagParams.TLSKeyFile); err != nil {
 			log.Fatal().Msgf("ListenAndServeTLS: %v", err)
 		}
 	} else {
-		log.Info().Msgf("%s v%s - HTTP listening %s", serviceName, serviceVersion, serviceListener)
+		log.Info().Msgf("%s v%s - HTTP listening %s", serviceName, buildVersion, serviceListener)
+		log.Info().Msgf("%s - commit=%s - build date=%s", serviceName, buildCommit, buildDate)
 		if err := http.ListenAndServe(serviceListener, adminMux); err != nil {
-			log.Fatal().Msgf("ListenAndServeTLS: %v", err)
+			log.Fatal().Msgf("ListenAndServe: %v", err)
 		}
 	}
 }

cmd/api/main.go

@@ -35,8 +35,6 @@ const (
 	projectName = "osctrl"
 	// Service name
 	serviceName = projectName + "-" + config.ServiceAPI
-	// Service version
-	serviceVersion = version.OsctrlVersion
 	// Service description
 	serviceDescription = "API service for osctrl"
 	// Application description
@@ -47,7 +45,7 @@ const (
 
 // Build-time metadata (overridden via -ldflags "-X main.buildVersion=... -X main.buildCommit=... -X main.buildDate=...")
 var (
-	buildVersion = serviceVersion
+	buildVersion = version.OsctrlVersion
 	buildCommit  = "unknown"
 	buildDate    = "unknown"
 )
@@ -207,7 +205,7 @@ func osctrlAPIService() {
 		handlers.WithCarves(filecarves),
 		handlers.WithSettings(settingsmgr),
 		handlers.WithCache(redis),
-		handlers.WithVersion(serviceVersion),
+		handlers.WithVersion(buildVersion),
 		handlers.WithName(serviceName),
 		handlers.WithDebugHTTP(&flagParams.DebugHTTPValues),
 	)
@@ -376,14 +374,16 @@ func osctrlAPIService() {
 			TLSConfig:    cfg,
 			TLSNextProto: make(map[string]func(*http.Server, *tls.Conn, http.Handler), 0),
 		}
-		log.Info().Msgf("%s v%s - HTTPS listening %s", serviceName, serviceVersion, serviceListener)
+		log.Info().Msgf("%s v%s - HTTPS listening %s", serviceName, buildVersion, serviceListener)
+		log.Info().Msgf("%s - commit=%s - build date=%s", serviceName, buildCommit, buildDate)
 		if err := srv.ListenAndServeTLS(flagParams.TLSCertFile, flagParams.TLSKeyFile); err != nil {
 			log.Fatal().Msgf("ListenAndServeTLS: %v", err)
 		}
 	} else {
-		log.Info().Msgf("%s v%s - HTTP listening %s", serviceName, serviceVersion, serviceListener)
+		log.Info().Msgf("%s v%s - HTTP listening %s", serviceName, buildVersion, serviceListener)
+		log.Info().Msgf("%s - commit=%s - build date=%s", serviceName, buildCommit, buildDate)
 		if err := http.ListenAndServe(serviceListener, muxAPI); err != nil {
-			log.Fatal().Msgf("ListenAndServeTLS: %v", err)
+			log.Fatal().Msgf("ListenAndServe: %v", err)
 		}
 	}
 }

cmd/tls/main.go

@@ -35,8 +35,6 @@ const (
 	projectName string = "osctrl"
 	// Service name
 	serviceName string = projectName + "-" + config.ServiceTLS
-	// Service version
-	serviceVersion string = version.OsctrlVersion
 	// Service description
 	serviceDescription string = "TLS service for osctrl"
 	// Application description
@@ -55,7 +53,7 @@ const (
 
 // Build-time metadata (overridden via -ldflags "-X main.buildVersion=... -X main.buildCommit=... -X main.buildDate=...")
 var (
-	buildVersion = serviceVersion
+	buildVersion = version.OsctrlVersion
 	buildCommit  = "unknown"
 	buildDate    = "unknown"
 )
@@ -334,14 +332,16 @@ func osctrlService() {
 			TLSConfig:    cfg,
 			TLSNextProto: make(map[string]func(*http.Server, *tls.Conn, http.Handler), 0),
 		}
-		log.Info().Msgf("%s v%s - HTTPS listening %s", serviceName, serviceVersion, serviceListener)
+		log.Info().Msgf("%s v%s - HTTPS listening %s", serviceName, buildVersion, serviceListener)
+		log.Info().Msgf("%s - commit=%s - build date=%s", serviceName, buildCommit, buildDate)
 		if err := srv.ListenAndServeTLS(flagParams.TLSCertFile, flagParams.TLSKeyFile); err != nil {
 			log.Fatal().Msgf("ListenAndServeTLS: %v", err)
 		}
 	} else {
-		log.Info().Msgf("%s v%s - HTTP listening %s", serviceName, serviceVersion, serviceListener)
+		log.Info().Msgf("%s v%s - HTTP listening %s", serviceName, buildVersion, serviceListener)
+		log.Info().Msgf("%s - commit=%s - build date=%s", serviceName, buildCommit, buildDate)
 		if err := http.ListenAndServe(serviceListener, muxTLS); err != nil {
-			log.Fatal().Msgf("ListenAndServeTLS: %v", err)
+			log.Fatal().Msgf("ListenAndServe: %v", err)
 		}
 	}
 }