mirror of
https://github.com/siderolabs/talos.git
synced 2025-12-03 00:21:17 +01:00
dad9c40c73
- replace `interface{}` with `any` using `gofmt -r 'interface{} -> any -w'`
- replace `a = []T{}` with `var a []T` where possible.
- replace `a = []T{}` with `a = make([]T, 0, len(b))` where possible.
Signed-off-by: Dmitriy Matrenichev <dmitry.matrenichev@siderolabs.com>
91 lines
2.4 KiB
Go
91 lines
2.4 KiB
Go
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
// License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
package runtime
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"io"
|
|
"time"
|
|
|
|
"go.uber.org/zap/zapcore"
|
|
)
|
|
|
|
// LoggingManager provides unified interface to publish and consume logs.
|
|
type LoggingManager interface {
|
|
// ServiceLog privides a log handler for a given service (that may not exist).
|
|
ServiceLog(service string) LogHandler
|
|
|
|
// SetSenders sets log senders for all derived log handlers
|
|
// and returns the previous ones for closing.
|
|
//
|
|
// SetSenders should be thread-safe.
|
|
SetSenders(senders []LogSender) []LogSender
|
|
|
|
// RegisteredLogs returns a list of registered logs containers.
|
|
RegisteredLogs() []string
|
|
}
|
|
|
|
// LogOptions for LogHandler.Reader.
|
|
type LogOptions struct {
|
|
Follow bool
|
|
TailLines *int
|
|
}
|
|
|
|
// LogOption provides functional options for LogHandler.Reader.
|
|
type LogOption func(*LogOptions) error
|
|
|
|
// WithFollow enables follow mode for the logs.
|
|
func WithFollow() LogOption {
|
|
return func(o *LogOptions) error {
|
|
o.Follow = true
|
|
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// WithTailLines starts log reading from lines from the tail of the log.
|
|
func WithTailLines(lines int) LogOption {
|
|
return func(o *LogOptions) error {
|
|
o.TailLines = &lines
|
|
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// LogHandler provides interface to access particular log source.
|
|
type LogHandler interface {
|
|
Writer() (io.WriteCloser, error)
|
|
Reader(opt ...LogOption) (io.ReadCloser, error)
|
|
}
|
|
|
|
// LogEvent represents a log message to be send.
|
|
type LogEvent struct {
|
|
Msg string
|
|
Time time.Time
|
|
Level zapcore.Level
|
|
Fields map[string]any
|
|
}
|
|
|
|
// ErrDontRetry indicates that log event should not be resent.
|
|
var ErrDontRetry = errors.New("don't retry")
|
|
|
|
// LogSender provides common interface for log senders.
|
|
type LogSender interface {
|
|
// Send tries to send the log event once, exiting on success, error, or context cancelation.
|
|
//
|
|
// Returned error is nil on success, non-nil otherwise.
|
|
// As a special case, Send can return (possibly wrapped) ErrDontRetry if the log event should not be resent
|
|
// (if it is invalid, if it was sent partially, etc).
|
|
//
|
|
// Send should be thread-safe.
|
|
Send(ctx context.Context, e *LogEvent) error
|
|
|
|
// Close stops the sender gracefully if possible, or forcefully on context cancelation.
|
|
//
|
|
// Close should be thread-safe.
|
|
Close(ctx context.Context) error
|
|
}
|