From b00dfd3965f400956c5bb5b388e9d54ef98052e5 Mon Sep 17 00:00:00 2001
From: Matt Holt <mholt@users.noreply.github.com>
Date: Mon, 28 Oct 2019 14:39:37 -0600
Subject: v2: Logging! (#2831)

* logging: Initial implementation

* logging: More encoder formats, better defaults

* logging: Fix repetition bug with FilterEncoder; add more presets

* logging: DiscardWriter; delete or no-op logs that discard their output

* logging: Add http.handlers.log module; enhance Replacer methods

The Replacer interface has new methods to customize how to handle empty
or unrecognized placeholders. Closes #2815.

* logging: Overhaul HTTP logging, fix bugs, improve filtering, etc.

* logging: General cleanup, begin transitioning to using new loggers

* Fixes after merge conflict
---
 caddy.go | 49 ++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 36 insertions(+), 13 deletions(-)

(limited to 'caddy.go')

diff --git a/caddy.go b/caddy.go
index fb3e488..dd241ee 100644
--- a/caddy.go
+++ b/caddy.go
@@ -29,16 +29,13 @@ import (
 
 // Config represents a Caddy configuration.
 type Config struct {
-	Admin *AdminConfig `json:"admin,omitempty"`
+	Admin      *AdminConfig               `json:"admin,omitempty"`
+	Logging    *Logging                   `json:"logging,omitempty"`
+	StorageRaw json.RawMessage            `json:"storage,omitempty"`
+	AppsRaw    map[string]json.RawMessage `json:"apps,omitempty"`
 
-	StorageRaw json.RawMessage `json:"storage,omitempty"`
-	storage    certmagic.Storage
-
-	AppsRaw map[string]json.RawMessage `json:"apps,omitempty"`
-
-	// apps stores the decoded Apps values,
-	// keyed by module name.
-	apps map[string]App
+	apps    map[string]App
+	storage certmagic.Storage
 
 	cancelFunc context.CancelFunc
 }
@@ -75,7 +72,11 @@ func Run(newCfg *Config) error {
 // is performed if any modules were provisioned;
 // apps that were started already will be stopped,
 // so this function should not leak resources if
-// an error is returned.
+// an error is returned. However, if no error is
+// returned and start == false, you should cancel
+// the config if you are not going to start it,
+// so that each provisioned module will be
+// cleaned up.
 func run(newCfg *Config, start bool) error {
 	if newCfg == nil {
 		return nil
@@ -102,12 +103,30 @@ func run(newCfg *Config, start bool) error {
 	ctx, cancel := NewContext(Context{Context: context.Background(), cfg: newCfg})
 	defer func() {
 		if err != nil {
-			cancel() // clean up now
+			// if there were any errors during startup,
+			// we should cancel the new context we created
+			// since the associated config won't be used;
+			// this will cause all modules that were newly
+			// provisioned to clean themselves up
+			cancel()
+
+			// also undo any other state changes we made
+			if currentCfg != nil {
+				certmagic.Default.Storage = currentCfg.storage
+			}
 		}
 	}()
 	newCfg.cancelFunc = cancel // clean up later
 
-	// set up storage and make it CertMagic's default storage, too
+	// set up logging before anything bad happens
+	if newCfg.Logging != nil {
+		err := newCfg.Logging.openLogs(ctx)
+		if err != nil {
+			return err
+		}
+	}
+
+	// set up global storage and make it CertMagic's default storage, too
 	err = func() error {
 		if newCfg.StorageRaw != nil {
 			val, err := ctx.LoadModuleInline("module", "caddy.storage", newCfg.StorageRaw)
@@ -214,7 +233,11 @@ func unsyncedStop(cfg *Config) {
 // Validate loads, provisions, and validates
 // cfg, but does not start running it.
 func Validate(cfg *Config) error {
-	return run(cfg, false)
+	err := run(cfg, false)
+	if err == nil {
+		cfg.cancelFunc() // call Cleanup on all modules
+	}
+	return err
 }
 
 // Duration is a JSON-string-unmarshable duration type.
-- 
cgit v1.2.3