mirrors/mostlymatter
1
0
Форкнуть 0
Код Задачи Запросы на слияние Действия Пакеты Проекты Релизы Вики Активность

[MM-37755] Idiomatic naming (SMTP, TLS, TCP, XML, CSS, HTML, HTTP) (#18103)

Просмотр исходного кода
Этот коммит содержится в:
Ben Schumacher
2021-08-12 11:49:16 +02:00
коммит произвёл GitHub
родитель bd65e8daf9
Коммит fd853e74a6
46 изменённых файлов: 223 добавлений и 223 удалений
Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

2
shared/mlog/levels.go
Просмотреть файл

@@ -28,7 +28,7 @@ var (
LvlAuditCLI = LogLevel{ID: 103, Name: "audit-cli"}
// used by the TCP log target
LvlTcpLogTarget = LogLevel{ID: 120, Name: "TcpLogTarget"}
LvlTCPLogTarget = LogLevel{ID: 120, Name: "TcpLogTarget"}
// used by Remote Cluster Service
LvlRemoteClusterServiceDebug = LogLevel{ID: 130, Name: "RemoteClusterServiceDebug"}

4
shared/mlog/logr.go
Просмотреть файл

@@ -181,7 +181,7 @@ func newSyslogTarget(name string, t *LogTarget, filter logr.Filter, formatter lo
}
func newTCPTarget(name string, t *LogTarget, filter logr.Filter, formatter logr.Formatter) (logr.Target, error) {
options := &TcpParams{}
options := &TCPParams{}
if err := json.Unmarshal(t.Options, options); err != nil {
return nil, err
}
@@ -192,7 +192,7 @@ func newTCPTarget(name string, t *LogTarget, filter logr.Filter, formatter logr.
if options.Port == 0 {
return nil, fmt.Errorf("missing 'Port' option for target %s", name)
}
return NewTcpTarget(filter, formatter, options, t.MaxQueueSize)
return NewTCPTarget(filter, formatter, options, t.MaxQueueSize)
}
func checkFileWritable(filename string) error {

56
shared/mlog/tcp.go
Просмотреть файл

@@ -24,11 +24,11 @@ const (
MaxRetryBackoffMillis int64 = 30 * 1000 // 30 seconds
)
// Tcp outputs log records to raw socket server.
type Tcp struct {
// TCP outputs log records to raw socket server.
type TCP struct {
logr.Basic
params *TcpParams
params *TCPParams
addy string
mutex sync.Mutex
@@ -37,8 +37,8 @@ type Tcp struct {
shutdown chan struct{}
}
// TcpParams provides parameters for dialing a socket server.
type TcpParams struct {
// TCPParams provides parameters for dialing a socket server.
type TCPParams struct {
IP string `json:"IP"`
Port int `json:"Port"`
TLS bool `json:"TLS"`
@@ -46,9 +46,9 @@ type TcpParams struct {
Insecure bool `json:"Insecure"`
}
// NewTcpTarget creates a target capable of outputting log records to a raw socket, with or without TLS.
func NewTcpTarget(filter logr.Filter, formatter logr.Formatter, params *TcpParams, maxQueue int) (*Tcp, error) {
tcp := &Tcp{
// NewTPCTarget creates a target capable of outputting log records to a raw socket, with or without TLS.
func NewTCPTarget(filter logr.Filter, formatter logr.Formatter, params *TCPParams, maxQueue int) (*TCP, error) {
tcp := &TCP{
params: params,
addy: fmt.Sprintf("%s:%d", params.IP, params.Port),
monitor: make(chan struct{}),
@@ -61,15 +61,15 @@ func NewTcpTarget(filter logr.Filter, formatter logr.Formatter, params *TcpParam
// getConn provides a net.Conn. If a connection already exists, it is returned immediately,
// otherwise this method blocks until a new connection is created, timeout or shutdown.
func (tcp *Tcp) getConn() (net.Conn, error) {
func (tcp *TCP) getConn() (net.Conn, error) {
tcp.mutex.Lock()
defer tcp.mutex.Unlock()
Log(LvlTcpLogTarget, "getConn enter", String("addy", tcp.addy))
defer Log(LvlTcpLogTarget, "getConn exit", String("addy", tcp.addy))
Log(LvlTCPLogTarget, "getConn enter", String("addy", tcp.addy))
defer Log(LvlTCPLogTarget, "getConn exit", String("addy", tcp.addy))
if tcp.conn != nil {
Log(LvlTcpLogTarget, "reusing existing conn", String("addy", tcp.addy)) // use "With" once Zap is removed
Log(LvlTCPLogTarget, "reusing existing conn", String("addy", tcp.addy)) // use "With" once Zap is removed
return tcp.conn, nil
}
@@ -83,7 +83,7 @@ func (tcp *Tcp) getConn() (net.Conn, error) {
defer cancel()
go func(ctx context.Context, ch chan result) {
Log(LvlTcpLogTarget, "dailing", String("addy", tcp.addy))
Log(LvlTCPLogTarget, "dailing", String("addy", tcp.addy))
conn, err := tcp.dial(ctx)
if err == nil {
tcp.conn = conn
@@ -103,7 +103,7 @@ func (tcp *Tcp) getConn() (net.Conn, error) {
// dial connects to a TCP socket, and optionally performs a TLS handshake.
// A non-nil context must be provided which can cancel the dial.
func (tcp *Tcp) dial(ctx context.Context) (net.Conn, error) {
func (tcp *TCP) dial(ctx context.Context) (net.Conn, error) {
var dialer net.Dialer
dialer.Timeout = time.Second * DialTimeoutSecs
conn, err := dialer.DialContext(ctx, "tcp", fmt.Sprintf("%s:%d", tcp.params.IP, tcp.params.Port))
@@ -115,7 +115,7 @@ func (tcp *Tcp) dial(ctx context.Context) (net.Conn, error) {
return conn, nil
}
Log(LvlTcpLogTarget, "TLS handshake", String("addy", tcp.addy))
Log(LvlTCPLogTarget, "TLS handshake", String("addy", tcp.addy))
tlsconfig := &tls.Config{
ServerName: tcp.params.IP,
@@ -136,13 +136,13 @@ func (tcp *Tcp) dial(ctx context.Context) (net.Conn, error) {
return tlsConn, nil
}
func (tcp *Tcp) close() error {
func (tcp *TCP) close() error {
tcp.mutex.Lock()
defer tcp.mutex.Unlock()
var err error
if tcp.conn != nil {
Log(LvlTcpLogTarget, "closing connection", String("addy", tcp.addy))
Log(LvlTCPLogTarget, "closing connection", String("addy", tcp.addy))
close(tcp.monitor)
err = tcp.conn.Close()
tcp.conn = nil
@@ -151,10 +151,10 @@ func (tcp *Tcp) close() error {
}
// Shutdown stops processing log records after making best effort to flush queue.
func (tcp *Tcp) Shutdown(ctx context.Context) error {
func (tcp *TCP) Shutdown(ctx context.Context) error {
errs := &multierror.Error{}
Log(LvlTcpLogTarget, "shutting down", String("addy", tcp.addy))
Log(LvlTCPLogTarget, "shutting down", String("addy", tcp.addy))
if err := tcp.Basic.Shutdown(ctx); err != nil {
errs = multierror.Append(errs, err)
@@ -170,7 +170,7 @@ func (tcp *Tcp) Shutdown(ctx context.Context) error {
// Write converts the log record to bytes, via the Formatter, and outputs to the socket.
// Called by dedicated target goroutine and will block until success or shutdown.
func (tcp *Tcp) Write(rec *logr.LogRec) error {
func (tcp *TCP) Write(rec *logr.LogRec) error {
_, stacktrace := tcp.IsLevelEnabled(rec.Level())
buf := rec.Logger().Logr().BorrowBuffer()
@@ -192,7 +192,7 @@ func (tcp *Tcp) Write(rec *logr.LogRec) error {
conn, err := tcp.getConn()
if err != nil {
Log(LvlTcpLogTarget, "failed getting connection", String("addy", tcp.addy), Err(err))
Log(LvlTCPLogTarget, "failed getting connection", String("addy", tcp.addy), Err(err))
reporter := rec.Logger().Logr().ReportError
reporter(fmt.Errorf("log target %s connection error: %w", tcp.String(), err))
backoff = tcp.sleep(backoff)
@@ -205,7 +205,7 @@ func (tcp *Tcp) Write(rec *logr.LogRec) error {
return nil
}
Log(LvlTcpLogTarget, "write error", String("addy", tcp.addy), Err(err))
Log(LvlTCPLogTarget, "write error", String("addy", tcp.addy), Err(err))
reporter := rec.Logger().Logr().ReportError
reporter(fmt.Errorf("log target %s write error: %w", tcp.String(), err))
@@ -213,7 +213,7 @@ func (tcp *Tcp) Write(rec *logr.LogRec) error {
backoff = tcp.sleep(backoff)
try++
Log(LvlTcpLogTarget, "retrying write", String("addy", tcp.addy), Int("try", try))
Log(LvlTCPLogTarget, "retrying write", String("addy", tcp.addy), Int("try", try))
}
}
@@ -223,11 +223,11 @@ func (tcp *Tcp) Write(rec *logr.LogRec) error {
// the writes simply fail without an error returned.
func monitor(conn net.Conn, done <-chan struct{}, logFunc LogFuncCustom) {
addy := conn.RemoteAddr().String()
defer logFunc(LvlTcpLogTarget, "monitor exiting", String("addy", addy))
defer logFunc(LvlTCPLogTarget, "monitor exiting", String("addy", addy))
buf := make([]byte, 1)
for {
logFunc(LvlTcpLogTarget, "monitor loop", String("addy", addy))
logFunc(LvlTCPLogTarget, "monitor loop", String("addy", addy))
select {
case <-done:
@@ -248,18 +248,18 @@ func monitor(conn net.Conn, done <-chan struct{}, logFunc LogFuncCustom) {
}
// Any other error closes the connection, forcing a reconnect.
logFunc(LvlTcpLogTarget, "monitor closing connection", Err(err))
logFunc(LvlTCPLogTarget, "monitor closing connection", Err(err))
conn.Close()
return
}
}
// String returns a string representation of this target.
func (tcp *Tcp) String() string {
func (tcp *TCP) String() string {
return fmt.Sprintf("TcpTarget[%s:%d]", tcp.params.IP, tcp.params.Port)
}
func (tcp *Tcp) sleep(backoff int64) int64 {
func (tcp *TCP) sleep(backoff int64) int64 {
select {
case <-tcp.shutdown:
case <-time.After(time.Millisecond * time.Duration(backoff)):

2
shared/mlog/tcp_test.go
Просмотреть файл

@@ -21,7 +21,7 @@ const (
testPort = 18066
)
func TestNewTcpTarget(t *testing.T) {
func TestNewTCPTarget(t *testing.T) {
target := LogTarget{
Type: "tcp",
Format: "json",