From ef5448324948537bb4ce798567d79d0612d41220 Mon Sep 17 00:00:00 2001
From: Matthew Holt <mholt@users.noreply.github.com>
Date: Thu, 7 Jan 2021 14:29:19 -0700
Subject: logging: Remove logfmt encoder (close #3575)

Has been deprecated for about 6 months now because it is broken.
---
 modules/logging/encoders.go | 56 ---------------------------------------------
 1 file changed, 56 deletions(-)

(limited to 'modules/logging')

diff --git a/modules/logging/encoders.go b/modules/logging/encoders.go
index 79382df..ab68f5e 100644
--- a/modules/logging/encoders.go
+++ b/modules/logging/encoders.go
@@ -22,7 +22,6 @@ import (
 
 	"github.com/caddyserver/caddy/v2"
 	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
-	zaplogfmt "github.com/jsternberg/zap-logfmt"
 	"go.uber.org/zap"
 	"go.uber.org/zap/buffer"
 	"go.uber.org/zap/zapcore"
@@ -31,7 +30,6 @@ import (
 func init() {
 	caddy.RegisterModule(ConsoleEncoder{})
 	caddy.RegisterModule(JSONEncoder{})
-	caddy.RegisterModule(LogfmtEncoder{})
 	caddy.RegisterModule(SingleFieldEncoder{})
 }
 
@@ -117,58 +115,6 @@ func (je *JSONEncoder) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
 	return nil
 }
 
-// LogfmtEncoder encodes log entries as logfmt:
-// https://www.brandur.org/logfmt
-//
-// Note that logfmt does not encode nested structures
-// properly, so it is not a good fit for most logs.
-//
-// ⚠️ DEPRECATED. Do not use. It will eventually be removed
-// from the standard Caddy modules. For more information,
-// see https://github.com/caddyserver/caddy/issues/3575.
-type LogfmtEncoder struct {
-	zapcore.Encoder `json:"-"`
-	LogEncoderConfig
-}
-
-// CaddyModule returns the Caddy module information.
-func (LogfmtEncoder) CaddyModule() caddy.ModuleInfo {
-	return caddy.ModuleInfo{
-		ID:  "caddy.logging.encoders.logfmt",
-		New: func() caddy.Module { return new(LogfmtEncoder) },
-	}
-}
-
-// Provision sets up the encoder.
-func (lfe *LogfmtEncoder) Provision(ctx caddy.Context) error {
-	ctx.Logger(lfe).Warn("the logfmt encoder is DEPRECATED and will soon be removed from the standard modules",
-		zap.String("recommendation", "switch to a log format that isn't broken"),
-		zap.String("more_info", "https://github.com/caddyserver/caddy/issues/3575"))
-	lfe.Encoder = zaplogfmt.NewEncoder(lfe.ZapcoreEncoderConfig())
-	return nil
-}
-
-// UnmarshalCaddyfile sets up the module from Caddyfile tokens. Syntax:
-//
-//     logfmt {
-//         <common encoder config subdirectives...>
-//     }
-//
-// See the godoc on the LogEncoderConfig type for the syntax of
-// subdirectives that are common to most/all encoders.
-func (lfe *LogfmtEncoder) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
-	for d.Next() {
-		if d.NextArg() {
-			return d.ArgErr()
-		}
-		err := lfe.LogEncoderConfig.UnmarshalCaddyfile(d)
-		if err != nil {
-			return err
-		}
-	}
-	return nil
-}
-
 // SingleFieldEncoder writes a log entry that consists entirely
 // of a single string field in the log entry. This is useful
 // for custom, self-encoded log entries that consist of a
@@ -398,11 +344,9 @@ var bufferpool = buffer.NewPool()
 var (
 	_ zapcore.Encoder = (*ConsoleEncoder)(nil)
 	_ zapcore.Encoder = (*JSONEncoder)(nil)
-	_ zapcore.Encoder = (*LogfmtEncoder)(nil)
 	_ zapcore.Encoder = (*SingleFieldEncoder)(nil)
 
 	_ caddyfile.Unmarshaler = (*ConsoleEncoder)(nil)
 	_ caddyfile.Unmarshaler = (*JSONEncoder)(nil)
-	_ caddyfile.Unmarshaler = (*LogfmtEncoder)(nil)
 	_ caddyfile.Unmarshaler = (*SingleFieldEncoder)(nil)
 )
-- 
cgit v1.2.3