From 87b6cf470baacd659cd20815de2804ae4a31df7f Mon Sep 17 00:00:00 2001 From: Matthew Holt Date: Thu, 12 Dec 2019 14:31:20 -0700 Subject: Minor improvements; comments and shorter placeholders & module IDs --- logging.go | 4 ++-- modules/caddyhttp/caddyauth/caddyauth.go | 2 +- modules/caddyhttp/matchers.go | 2 +- modules/caddyhttp/reverseproxy/caddyfile.go | 4 ++-- modules/caddyhttp/reverseproxy/command.go | 2 +- modules/caddyhttp/reverseproxy/reverseproxy.go | 14 +++++++------- modules/caddyhttp/server.go | 6 +++++- 7 files changed, 19 insertions(+), 15 deletions(-) diff --git a/logging.go b/logging.go index 3fdd644..0b7d9e4 100644 --- a/logging.go +++ b/logging.go @@ -561,10 +561,10 @@ type LogSampling struct { } type ( - // StdoutWriter can write logs to stdout. + // StdoutWriter writes logs to standard out. StdoutWriter struct{} - // StderrWriter can write logs to stdout. + // StderrWriter writes logs to standard error. StderrWriter struct{} // DiscardWriter discards all writes. diff --git a/modules/caddyhttp/caddyauth/caddyauth.go b/modules/caddyhttp/caddyauth/caddyauth.go index c79d080..c814caf 100644 --- a/modules/caddyhttp/caddyauth/caddyauth.go +++ b/modules/caddyhttp/caddyauth/caddyauth.go @@ -74,7 +74,7 @@ func (a Authentication) ServeHTTP(w http.ResponseWriter, r *http.Request, next c } repl := r.Context().Value(caddy.ReplacerCtxKey).(caddy.Replacer) - repl.Set("http.handlers.authentication.user.id", user.ID) + repl.Set("http.authentication.user.id", user.ID) return next.ServeHTTP(w, r) } diff --git a/modules/caddyhttp/matchers.go b/modules/caddyhttp/matchers.go index ea715c5..eaa27f0 100644 --- a/modules/caddyhttp/matchers.go +++ b/modules/caddyhttp/matchers.go @@ -596,7 +596,7 @@ func (m MatchRemoteIP) Match(r *http.Request) bool { // CaddyModule returns the Caddy module information. func (MatchStarlarkExpr) CaddyModule() caddy.ModuleInfo { return caddy.ModuleInfo{ - ID: "http.matchers.starlark_expr", // TODO: Rename to 'starlark'? + ID: "http.matchers.starlark", New: func() caddy.Module { return new(MatchStarlarkExpr) }, } } diff --git a/modules/caddyhttp/reverseproxy/caddyfile.go b/modules/caddyhttp/reverseproxy/caddyfile.go index 9dba769..c9afa2a 100644 --- a/modules/caddyhttp/reverseproxy/caddyfile.go +++ b/modules/caddyhttp/reverseproxy/caddyfile.go @@ -106,7 +106,7 @@ func (h *Handler) UnmarshalCaddyfile(d *caddyfile.Dispenser) error { return d.Err("load balancing selection policy already specified") } name := d.Val() - mod, err := caddy.GetModule("http.handlers.reverse_proxy.selection_policies." + name) + mod, err := caddy.GetModule("http.reverse_proxy.selection_policies." + name) if err != nil { return d.Errf("getting load balancing policy module '%s': %v", mod, err) } @@ -389,7 +389,7 @@ func (h *Handler) UnmarshalCaddyfile(d *caddyfile.Dispenser) error { return d.Err("transport already specified") } name := d.Val() - mod, err := caddy.GetModule("http.handlers.reverse_proxy.transport." + name) + mod, err := caddy.GetModule("http.reverse_proxy.transport." + name) if err != nil { return d.Errf("getting transport module '%s': %v", mod, err) } diff --git a/modules/caddyhttp/reverseproxy/command.go b/modules/caddyhttp/reverseproxy/command.go index e16c4f5..1638d82 100644 --- a/modules/caddyhttp/reverseproxy/command.go +++ b/modules/caddyhttp/reverseproxy/command.go @@ -100,7 +100,7 @@ func cmdReverseProxy(fs caddycmd.Flags) (int, error) { Headers: &headers.Handler{ Request: &headers.HeaderOps{ Set: http.Header{ - "Host": []string{"{http.handlers.reverse_proxy.upstream.host}"}, + "Host": []string{"{http.reverse_proxy.upstream.host}"}, }, }, }, diff --git a/modules/caddyhttp/reverseproxy/reverseproxy.go b/modules/caddyhttp/reverseproxy/reverseproxy.go index 132f222..d353dc1 100644 --- a/modules/caddyhttp/reverseproxy/reverseproxy.go +++ b/modules/caddyhttp/reverseproxy/reverseproxy.go @@ -288,13 +288,13 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyht r = r.WithContext(ctx) // set placeholders with information about this upstream - repl.Set("http.handlers.reverse_proxy.upstream.address", dialInfo.String()) - repl.Set("http.handlers.reverse_proxy.upstream.hostport", dialInfo.Address) - repl.Set("http.handlers.reverse_proxy.upstream.host", dialInfo.Host) - repl.Set("http.handlers.reverse_proxy.upstream.port", dialInfo.Port) - repl.Set("http.handlers.reverse_proxy.upstream.requests", strconv.Itoa(upstream.Host.NumRequests())) - repl.Set("http.handlers.reverse_proxy.upstream.max_requests", strconv.Itoa(upstream.MaxRequests)) - repl.Set("http.handlers.reverse_proxy.upstream.fails", strconv.Itoa(upstream.Host.Fails())) + repl.Set("http.reverse_proxy.upstream.address", dialInfo.String()) + repl.Set("http.reverse_proxy.upstream.hostport", dialInfo.Address) + repl.Set("http.reverse_proxy.upstream.host", dialInfo.Host) + repl.Set("http.reverse_proxy.upstream.port", dialInfo.Port) + repl.Set("http.reverse_proxy.upstream.requests", strconv.Itoa(upstream.Host.NumRequests())) + repl.Set("http.reverse_proxy.upstream.max_requests", strconv.Itoa(upstream.MaxRequests)) + repl.Set("http.reverse_proxy.upstream.fails", strconv.Itoa(upstream.Host.Fails())) // mutate request headers according to this upstream; // because we're in a retry loop, we have to copy diff --git a/modules/caddyhttp/server.go b/modules/caddyhttp/server.go index c34444e..83b90e6 100644 --- a/modules/caddyhttp/server.go +++ b/modules/caddyhttp/server.go @@ -447,6 +447,10 @@ func (*HTTPErrorConfig) WithError(r *http.Request, err error) *http.Request { // ServerLogConfig describes a server's logging configuration. type ServerLogConfig struct { + // LoggerNames maps request hostnames to a custom logger name. + // For example, a mapping of "example.com" to "example" would + // cause access logs from requests with a Host of example.com + // to be emitted by a logger named "http.log.access.example". LoggerNames map[string]string `json:"logger_names,omitempty"` } @@ -504,7 +508,7 @@ func cloneURL(from, to *url.URL) { const ( // CommonLogFormat is the common log format. https://en.wikipedia.org/wiki/Common_Log_Format - CommonLogFormat = `{http.request.remote.host} ` + CommonLogEmptyValue + ` {http.handlers.authentication.user.id} [{time.now.common_log}] "{http.request.orig_method} {http.request.orig_uri} {http.request.proto}" {http.response.status} {http.response.size}` + CommonLogFormat = `{http.request.remote.host} ` + CommonLogEmptyValue + ` {http.authentication.user.id} [{time.now.common_log}] "{http.request.orig_method} {http.request.orig_uri} {http.request.proto}" {http.response.status} {http.response.size}` // CommonLogEmptyValue is the common empty log value. CommonLogEmptyValue = "-" -- cgit v1.2.3