logging

Documentation

Overview

Copyright 2017 HootSuite Media Inc.

Licensed under the Apache License, Version 2.0 (the License); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Modified hereafter by contributors to runatlantis/atlantis.

Package logging handles logging throughout Atlantis.

Index

• Variables
• func SuppressDefaultLogging()
• type LogLevel
• type SimpleLogging
  • func NewNoopLogger(t zaptest.TestingT) SimpleLogging
  • func NewStructuredLogger() (SimpleLogging, error)
  • func NewStructuredLoggerFromLevel(lvl LogLevel) (SimpleLogging, error)
• type StructuredLogger
  • func (l *StructuredLogger) Debug(format string, a ...interface{})
  • func (l *StructuredLogger) Err(format string, a ...interface{})
  • func (l *StructuredLogger) Flush() error
  • func (l *StructuredLogger) GetHistory() string
  • func (l *StructuredLogger) Info(format string, a ...interface{})
  • func (l *StructuredLogger) Log(level LogLevel, format string, a ...interface{})
  • func (l *StructuredLogger) SetLevel(lvl LogLevel)
  • func (l *StructuredLogger) Warn(format string, a ...interface{})
  • func (l *StructuredLogger) With(a ...interface{}) SimpleLogging
  • func (l *StructuredLogger) WithHistory(a ...interface{}) SimpleLogging

Variables

var (
	Debug = LogLevel{
			// contains filtered or unexported fields
	}
	Info = LogLevel{
			// contains filtered or unexported fields
	}
	Warn = LogLevel{
			// contains filtered or unexported fields
	}
	Error = LogLevel{
			// contains filtered or unexported fields
	}
)

Functions

func SuppressDefaultLogging

func SuppressDefaultLogging()

SuppressDefaultLogging suppresses the default logging

Types

type LogLevel

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

type SimpleLogging

type SimpleLogging interface {

	// These basically just fmt.Sprintf() the message and args.
	Debug(format string, a ...interface{})
	Info(format string, a ...interface{})
	Warn(format string, a ...interface{})
	Err(format string, a ...interface{})
	Log(level LogLevel, format string, a ...interface{})
	SetLevel(lvl LogLevel)

	// With adds a variadic number of fields to the logging context. It accepts a
	// mix of strongly-typed Field objects and loosely-typed key-value pairs. When
	// processing pairs, the first element of the pair is used as the field key
	// and the second as the field value.
	With(a ...interface{}) SimpleLogging

	// Creates a new logger with history preserved . log storage + search strategies
	// should ideally be used instead of managing this ourselves.
	// keeping as a separate method to ensure that usage of history is completely intentional
	WithHistory(a ...interface{}) SimpleLogging

	// Fetches the history we've stored associated with the logging context
	GetHistory() string

	// Flushes anything left in the buffer
	Flush() error
}

SimpleLogging is the interface used for logging throughout the codebase.

func NewNoopLogger

func NewNoopLogger(t zaptest.TestingT) SimpleLogging

NewNoopLogger creates a logger instance that discards all logs and never writes them. Used for testing.

func NewStructuredLogger

func NewStructuredLogger() (SimpleLogging, error)

func NewStructuredLoggerFromLevel

func NewStructuredLoggerFromLevel(lvl LogLevel) (SimpleLogging, error)

type StructuredLogger

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

func (*StructuredLogger) Debug

func (l *StructuredLogger) Debug(format string, a ...interface{})

func (*StructuredLogger) Err

func (l *StructuredLogger) Err(format string, a ...interface{})

func (*StructuredLogger) Flush

func (l *StructuredLogger) Flush() error

func (*StructuredLogger) GetHistory

func (l *StructuredLogger) GetHistory() string

func (*StructuredLogger) Info

func (l *StructuredLogger) Info(format string, a ...interface{})

func (*StructuredLogger) Log

func (l *StructuredLogger) Log(level LogLevel, format string, a ...interface{})

func (*StructuredLogger) SetLevel

func (l *StructuredLogger) SetLevel(lvl LogLevel)

func (*StructuredLogger) Warn

func (l *StructuredLogger) Warn(format string, a ...interface{})

func (*StructuredLogger) With

func (l *StructuredLogger) With(a ...interface{}) SimpleLogging

func (*StructuredLogger) WithHistory

func (l *StructuredLogger) WithHistory(a ...interface{}) SimpleLogging