Browse Source

unify "startup", "rehash", and "shutdown" log categories as "server"

tags/v1.0.0-rc1
Shivaram Lingamneni 5 years ago
parent
commit
cbe0f79f73
4 changed files with 30 additions and 30 deletions
  1. 2
    2
      irc/handlers.go
  2. 20
    20
      irc/server.go
  3. 7
    7
      oragono.go
  4. 1
    1
      oragono.yaml

+ 2
- 2
irc/handlers.go View File

@@ -1886,13 +1886,13 @@ func quitHandler(server *Server, client *Client, msg ircmsg.IrcMessage, rb *Resp
1886 1886
 
1887 1887
 // REHASH
1888 1888
 func rehashHandler(server *Server, client *Client, msg ircmsg.IrcMessage, rb *ResponseBuffer) bool {
1889
-	server.logger.Info("rehash", fmt.Sprintf("REHASH command used by %s", client.nick))
1889
+	server.logger.Info("server", fmt.Sprintf("REHASH command used by %s", client.nick))
1890 1890
 	err := server.rehash()
1891 1891
 
1892 1892
 	if err == nil {
1893 1893
 		rb.Add(nil, server.name, RPL_REHASHING, client.nick, "ircd.yaml", client.t("Rehashing"))
1894 1894
 	} else {
1895
-		server.logger.Error("rehash", fmt.Sprintln("Failed to rehash:", err.Error()))
1895
+		server.logger.Error("server", fmt.Sprintln("Failed to rehash:", err.Error()))
1896 1896
 		rb.Add(nil, server.name, ERR_UNKNOWNERROR, client.nick, "REHASH", err.Error())
1897 1897
 	}
1898 1898
 	return false

+ 20
- 20
irc/server.go View File

@@ -235,10 +235,10 @@ func (server *Server) Run() {
235 235
 
236 236
 		case <-server.rehashSignal:
237 237
 			go func() {
238
-				server.logger.Info("rehash", "Rehashing due to SIGHUP")
238
+				server.logger.Info("server", "Rehashing due to SIGHUP")
239 239
 				err := server.rehash()
240 240
 				if err != nil {
241
-					server.logger.Error("rehash", fmt.Sprintln("Failed to rehash:", err.Error()))
241
+					server.logger.Error("server", fmt.Sprintln("Failed to rehash:", err.Error()))
242 242
 				}
243 243
 			}()
244 244
 		}
@@ -567,13 +567,13 @@ func whoChannel(client *Client, channel *Channel, friends ClientSet, rb *Respons
567 567
 
568 568
 // rehash reloads the config and applies the changes from the config file.
569 569
 func (server *Server) rehash() error {
570
-	server.logger.Debug("rehash", "Starting rehash")
570
+	server.logger.Debug("server", "Starting rehash")
571 571
 
572 572
 	// only let one REHASH go on at a time
573 573
 	server.rehashMutex.Lock()
574 574
 	defer server.rehashMutex.Unlock()
575 575
 
576
-	server.logger.Debug("rehash", "Got rehash lock")
576
+	server.logger.Debug("server", "Got rehash lock")
577 577
 
578 578
 	config, err := LoadConfig(server.configFilename)
579 579
 	if err != nil {
@@ -607,7 +607,7 @@ func (server *Server) applyConfig(config *Config, initial bool) (err error) {
607 607
 	}
608 608
 
609 609
 	// sanity checks complete, start modifying server state
610
-	server.logger.Info("rehash", "Using config file", server.configFilename)
610
+	server.logger.Info("server", "Using config file", server.configFilename)
611 611
 	oldConfig := server.Config()
612 612
 
613 613
 	// first, reload config sections for functionality implemented in subpackages:
@@ -649,7 +649,7 @@ func (server *Server) applyConfig(config *Config, initial bool) (err error) {
649 649
 		}
650 650
 	}
651 651
 	newLanguageValue := strings.Join(langCodes, ",")
652
-	server.logger.Debug("rehash", "Languages:", newLanguageValue)
652
+	server.logger.Debug("server", "Languages:", newLanguageValue)
653 653
 
654 654
 	if currentLanguageValue != newLanguageValue {
655 655
 		updatedCaps.Add(caps.Languages)
@@ -658,7 +658,7 @@ func (server *Server) applyConfig(config *Config, initial bool) (err error) {
658 658
 
659 659
 	lm := languages.NewManager(config.Languages.Default, config.Languages.Data)
660 660
 
661
-	server.logger.Debug("rehash", "Regenerating HELP indexes for new languages")
661
+	server.logger.Debug("server", "Regenerating HELP indexes for new languages")
662 662
 	GenerateHelpIndices(lm)
663 663
 
664 664
 	server.languages = lm
@@ -700,7 +700,7 @@ func (server *Server) applyConfig(config *Config, initial bool) (err error) {
700 700
 	stsValue := config.Server.STS.Value()
701 701
 	stsDisabledByRehash := false
702 702
 	stsCurrentCapValue, _ := CapValues.Get(caps.STS)
703
-	server.logger.Debug("rehash", "STS Vals", stsCurrentCapValue, stsValue, fmt.Sprintf("server[%v] config[%v]", stsPreviouslyEnabled, config.Server.STS.Enabled))
703
+	server.logger.Debug("server", "STS Vals", stsCurrentCapValue, stsValue, fmt.Sprintf("server[%v] config[%v]", stsPreviouslyEnabled, config.Server.STS.Enabled))
704 704
 	if config.Server.STS.Enabled && !stsPreviouslyEnabled {
705 705
 		// enabling STS
706 706
 		SupportedCapabilities.Enable(caps.STS)
@@ -738,7 +738,7 @@ func (server *Server) applyConfig(config *Config, initial bool) (err error) {
738 738
 
739 739
 	// updated caps get DEL'd and then NEW'd
740 740
 	// so, we can just add updated ones to both removed and added lists here and they'll be correctly handled
741
-	server.logger.Debug("rehash", "Updated Caps", updatedCaps.String(caps.Cap301, CapValues))
741
+	server.logger.Debug("server", "Updated Caps", updatedCaps.String(caps.Cap301, CapValues))
742 742
 	addedCaps.Union(updatedCaps)
743 743
 	removedCaps.Union(updatedCaps)
744 744
 
@@ -779,7 +779,7 @@ func (server *Server) applyConfig(config *Config, initial bool) (err error) {
779 779
 	server.config = config
780 780
 	server.configurableStateMutex.Unlock()
781 781
 
782
-	server.logger.Info("rehash", "Using datastore", config.Datastore.Path)
782
+	server.logger.Info("server", "Using datastore", config.Datastore.Path)
783 783
 	if initial {
784 784
 		if err := server.loadDatastore(config); err != nil {
785 785
 			return err
@@ -825,7 +825,7 @@ func (server *Server) setupPprofListener(config *Config) {
825 825
 	}
826 826
 	if server.pprofServer != nil {
827 827
 		if pprofListener == "" || (pprofListener != server.pprofServer.Addr) {
828
-			server.logger.Info("rehash", "Stopping pprof listener", server.pprofServer.Addr)
828
+			server.logger.Info("server", "Stopping pprof listener", server.pprofServer.Addr)
829 829
 			server.pprofServer.Close()
830 830
 			server.pprofServer = nil
831 831
 		}
@@ -836,16 +836,16 @@ func (server *Server) setupPprofListener(config *Config) {
836 836
 		}
837 837
 		go func() {
838 838
 			if err := ps.ListenAndServe(); err != nil {
839
-				server.logger.Error("rehash", "pprof listener failed", err.Error())
839
+				server.logger.Error("server", "pprof listener failed", err.Error())
840 840
 			}
841 841
 		}()
842 842
 		server.pprofServer = &ps
843
-		server.logger.Info("rehash", "Started pprof listener", server.pprofServer.Addr)
843
+		server.logger.Info("server", "Started pprof listener", server.pprofServer.Addr)
844 844
 	}
845 845
 }
846 846
 
847 847
 func (server *Server) loadMOTD(motdPath string, useFormatting bool) error {
848
-	server.logger.Info("rehash", "Using MOTD", motdPath)
848
+	server.logger.Info("server", "Using MOTD", motdPath)
849 849
 	motdLines := make([]string, 0)
850 850
 	if motdPath != "" {
851 851
 		file, err := os.Open(motdPath)
@@ -887,7 +887,7 @@ func (server *Server) loadDatastore(config *Config) error {
887 887
 
888 888
 	_, err := os.Stat(config.Datastore.Path)
889 889
 	if os.IsNotExist(err) {
890
-		server.logger.Warning("rehash", "database does not exist, creating it", config.Datastore.Path)
890
+		server.logger.Warning("server", "database does not exist, creating it", config.Datastore.Path)
891 891
 		err = initializeDB(config.Datastore.Path)
892 892
 		if err != nil {
893 893
 			return err
@@ -902,7 +902,7 @@ func (server *Server) loadDatastore(config *Config) error {
902 902
 	}
903 903
 
904 904
 	// load *lines (from the datastores)
905
-	server.logger.Debug("rehash", "Loading D/Klines")
905
+	server.logger.Debug("server", "Loading D/Klines")
906 906
 	server.loadDLines()
907 907
 	server.loadKLines()
908 908
 
@@ -922,7 +922,7 @@ func (server *Server) setupListeners(config *Config) (err error) {
922 922
 
923 923
 	tlsListeners, err := config.TLSListeners()
924 924
 	if err != nil {
925
-		server.logger.Error("rehash", "failed to reload TLS certificates, aborting rehash", err.Error())
925
+		server.logger.Error("server", "failed to reload TLS certificates, aborting rehash", err.Error())
926 926
 		return
927 927
 	}
928 928
 
@@ -964,7 +964,7 @@ func (server *Server) setupListeners(config *Config) (err error) {
964 964
 			tlsConfig := tlsListeners[newaddr]
965 965
 			listener, listenerErr := server.createListener(newaddr, tlsConfig, config.Server.UnixBindMode)
966 966
 			if listenerErr != nil {
967
-				server.logger.Error("rehash", "couldn't listen on", newaddr, listenerErr.Error())
967
+				server.logger.Error("server", "couldn't listen on", newaddr, listenerErr.Error())
968 968
 				err = listenerErr
969 969
 				continue
970 970
 			}
@@ -974,7 +974,7 @@ func (server *Server) setupListeners(config *Config) (err error) {
974 974
 	}
975 975
 
976 976
 	if len(tlsListeners) == 0 {
977
-		server.logger.Warning("rehash", "You are not exposing an SSL/TLS listening port. You should expose at least one port (typically 6697) to accept TLS connections")
977
+		server.logger.Warning("server", "You are not exposing an SSL/TLS listening port. You should expose at least one port (typically 6697) to accept TLS connections")
978 978
 	}
979 979
 
980 980
 	var usesStandardTLSPort bool
@@ -985,7 +985,7 @@ func (server *Server) setupListeners(config *Config) (err error) {
985 985
 		}
986 986
 	}
987 987
 	if 0 < len(tlsListeners) && !usesStandardTLSPort {
988
-		server.logger.Warning("rehash", "Port 6697 is the standard TLS port for IRC. You should (also) expose port 6697 as a TLS port to ensure clients can connect securely")
988
+		server.logger.Warning("server", "Port 6697 is the standard TLS port for IRC. You should (also) expose port 6697 as a TLS port to ensure clients can connect securely")
989 989
 	}
990 990
 
991 991
 	return

+ 7
- 7
oragono.go View File

@@ -130,11 +130,11 @@ Options:
130 130
 		}
131 131
 	} else if arguments["run"].(bool) {
132 132
 		if !arguments["--quiet"].(bool) {
133
-			logman.Info("startup", fmt.Sprintf("Oragono v%s starting", irc.SemVer))
133
+			logman.Info("server", fmt.Sprintf("Oragono v%s starting", irc.SemVer))
134 134
 			if commit == "" {
135
-				logman.Debug("startup", fmt.Sprintf("Could not get current commit"))
135
+				logman.Debug("server", fmt.Sprintf("Could not get current commit"))
136 136
 			} else {
137
-				logman.Info("startup", fmt.Sprintf("Running commit %s", commit))
137
+				logman.Info("server", fmt.Sprintf("Running commit %s", commit))
138 138
 			}
139 139
 		}
140 140
 
@@ -146,17 +146,17 @@ Options:
146 146
 
147 147
 		// warning if running a non-final version
148 148
 		if strings.Contains(irc.SemVer, "unreleased") {
149
-			logman.Warning("startup", "You are currently running an unreleased beta version of Oragono that may be unstable and could corrupt your database.\nIf you are running a production network, please download the latest build from https://oragono.io/downloads.html and run that instead.")
149
+			logman.Warning("server", "You are currently running an unreleased beta version of Oragono that may be unstable and could corrupt your database.\nIf you are running a production network, please download the latest build from https://oragono.io/downloads.html and run that instead.")
150 150
 		}
151 151
 
152 152
 		server, err := irc.NewServer(config, logman)
153 153
 		if err != nil {
154
-			logman.Error("startup", fmt.Sprintf("Could not load server: %s", err.Error()))
154
+			logman.Error("server", fmt.Sprintf("Could not load server: %s", err.Error()))
155 155
 			return
156 156
 		}
157 157
 		if !arguments["--quiet"].(bool) {
158
-			logman.Info("startup", "Server running")
159
-			defer logman.Info("shutdown", fmt.Sprintf("Oragono v%s exiting", irc.SemVer))
158
+			logman.Info("server", "Server running")
159
+			defer logman.Info("server", fmt.Sprintf("Oragono v%s exiting", irc.SemVer))
160 160
 		}
161 161
 		server.Run()
162 162
 	}

+ 1
- 1
oragono.yaml View File

@@ -354,12 +354,12 @@ logging:
354 354
         #
355 355
         # useful types include:
356 356
         #   *               everything (usually used with exclusing some types below)
357
+        #   server          server startup, rehash, and shutdown events
357 358
         #   accounts        account registration and authentication
358 359
         #   channels        channel creation and operations
359 360
         #   commands        command calling and operations
360 361
         #   opers           oper actions, authentication, etc
361 362
         #   password        password hashing and comparing
362
-        #   rehash          server startup and rehash events
363 363
         #   userinput       raw lines sent by users
364 364
         #   useroutput      raw lines sent to users
365 365
         type: "* -userinput -useroutput -localconnect -localconnect-ip"

Loading…
Cancel
Save