stdout

Documentation

Index

• type Option
  • func WithFlushInterval(d time.Duration) Option
• type StdoutOutput
  • func New(logger *zap.Logger, opts ...Option) (*StdoutOutput, error)
  • func (o *StdoutOutput) Stop(ctx context.Context) error
  • func (o *StdoutOutput) SupportedTelemetry() []telemetry.Type
  • func (o *StdoutOutput) Write(_ context.Context, data output.LogRecord) error
  • func (o *StdoutOutput) WriteMetric(_ context.Context, data output.MetricRecord) error
  • func (o *StdoutOutput) WriteTrace(_ context.Context, data output.TraceRecord) error

Types

type Option

type Option func(*config) error

Option is a functional option for configuring the stdout output.

func WithFlushInterval

func WithFlushInterval(d time.Duration) Option

WithFlushInterval sets the interval at which the internal buffer is flushed to stdout.

type StdoutOutput

type StdoutOutput struct {
	// contains filtered or unexported fields
}

StdoutOutput writes log records to standard output via a buffered writer. Records are batched in memory and flushed to os.Stdout periodically, reducing per-record syscall overhead under high worker counts.

func New

func New(logger *zap.Logger, opts ...Option) (*StdoutOutput, error)

New creates a new stdout output. The goroutine that drives periodic flushing starts immediately and runs until Stop is called.

func (*StdoutOutput) Stop

func (o *StdoutOutput) Stop(ctx context.Context) error

Stop signals the flush goroutine to exit and performs a best-effort flush of any buffered records. Records remaining in the buffer on a hard kill are lost.

func (*StdoutOutput) SupportedTelemetry

func (o *StdoutOutput) SupportedTelemetry() []telemetry.Type

SupportedTelemetry returns the telemetry types this output can consume.

func (*StdoutOutput) Write

func (o *StdoutOutput) Write(_ context.Context, data output.LogRecord) error

Write buffers the log record for the next flush.

func (*StdoutOutput) WriteMetric

func (o *StdoutOutput) WriteMetric(_ context.Context, data output.MetricRecord) error

WriteMetric writes a metric record to stdout as JSON.

func (*StdoutOutput) WriteTrace

func (o *StdoutOutput) WriteTrace(_ context.Context, data output.TraceRecord) error

WriteTrace writes a trace record to stdout as JSON.