README
¶
Echelon - hierarchical progress in terminals
Cross-platform library to organize logs in a hierarchical structure.
Here is an example how it looks for running Dockerized tasks via Cirrus CLI:
Features
- Customizable and works with any VT100 compatible terminal
- Supports simplified output for dumb terminals
- Implements incremental drawing algorithm to optimize drawing performance
- Can be used from multiple goroutines
- Pluggable and customizable renderers
- Works on Windows!
Example
Please check demo folder for a simple example or how echelon is used in Cirrus CLI.
Documentation
¶
Index ¶
- type FinishType
- type LogEntryMessage
- type LogLevel
- type LogRendered
- type LogScopeFinished
- type LogScopeStarted
- type Logger
- func (logger *Logger) AsWriter(level LogLevel) io.Writer
- func (logger *Logger) Debugf(format string, args ...interface{})
- func (logger *Logger) Errorf(format string, args ...interface{})
- func (logger *Logger) Finish(success bool)
- func (logger *Logger) FinishWithType(finishType FinishType)
- func (logger *Logger) Infof(format string, args ...interface{})
- func (logger *Logger) IsLogLevelEnabled(level LogLevel) bool
- func (logger *Logger) Logf(level LogLevel, format string, args ...interface{})
- func (logger *Logger) Renderer() LogRendered
- func (logger *Logger) Scoped(scope string) *Logger
- func (logger *Logger) Tracef(format string, args ...interface{})
- func (logger *Logger) Warnf(format string, args ...interface{})
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FinishType ¶ added in v1.5.0
type FinishType int
const ( FinishTypeSucceeded FinishType = iota FinishTypeFailed FinishTypeSkipped )
type LogEntryMessage ¶
type LogEntryMessage struct {
Level LogLevel
// contains filtered or unexported fields
}
func NewLogEntryMessage ¶
func NewLogEntryMessage(scopes []string, level LogLevel, format string, arguments ...interface{}) *LogEntryMessage
func (*LogEntryMessage) GetMessage ¶
func (entry *LogEntryMessage) GetMessage() string
func (*LogEntryMessage) GetScopes ¶
func (entry *LogEntryMessage) GetScopes() []string
type LogRendered ¶
type LogRendered interface {
RenderScopeStarted(entry *LogScopeStarted)
RenderScopeFinished(entry *LogScopeFinished)
RenderMessage(entry *LogEntryMessage)
}
type LogScopeFinished ¶
type LogScopeFinished struct {
// contains filtered or unexported fields
}
func NewLogScopeFinished ¶
func NewLogScopeFinished(finishType FinishType, scopes ...string) *LogScopeFinished
func (*LogScopeFinished) FinishType ¶ added in v1.5.0
func (entry *LogScopeFinished) FinishType() FinishType
func (*LogScopeFinished) GetScopes ¶
func (entry *LogScopeFinished) GetScopes() []string
type LogScopeStarted ¶
type LogScopeStarted struct {
// contains filtered or unexported fields
}
func NewLogScopeStarted ¶
func NewLogScopeStarted(scopes ...string) *LogScopeStarted
func (*LogScopeStarted) GetScopes ¶
func (entry *LogScopeStarted) GetScopes() []string
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
func NewLogger ¶
func NewLogger(level LogLevel, renderer LogRendered) *Logger
func (*Logger) FinishWithType ¶ added in v1.5.0
func (logger *Logger) FinishWithType(finishType FinishType)
func (*Logger) IsLogLevelEnabled ¶
func (*Logger) Renderer ¶ added in v1.7.0
func (logger *Logger) Renderer() LogRendered
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.