Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename loglevel to level and LogLevel to Level #15

Merged
merged 1 commit into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ By default, root logger prints on console only, and starting from Warning level.
level:

```go
logger.Configure(logger.NewConfiguration(logger.WithFromLevel(loglevel.All)))
logger.Configure(logger.NewConfiguration(logger.WithFromLevel(level.All)))
```

After changing log level to "None" it will print messages for any level.
Expand Down Expand Up @@ -81,27 +81,27 @@ There are three predefined types of handler:
messages, and formatter that tells how to log message. It logs messages to standard output.

```go
newConsoleHandler := handler.NewConsoleHandler(loglevel.Debug, loglevel.Null, applicationFormatter)
newConsoleHandler := handler.NewConsoleHandler(level.Debug, level.Null, applicationFormatter)
```

- Console Error Handler - it takes log level starting from which it would log messages, log level till which it would
log messages, and formatter that tells how to log message. It logs messages to error output.

```go
newConsoleErrorHandler := handler.NewConsoleErrorHandler(loglevel.Debug, loglevel.Null, applicationFormatter)
newConsoleErrorHandler := handler.NewConsoleErrorHandler(level.Debug, level.Null, applicationFormatter)
```

- File Handler - it takes log level starting from which it would log messages, log level till which it would
log messages, formatter that tells how to log message, and path to the file where to log those data.

```go
newFileHandler := handler.NewFileHandler(loglevel.Debug, loglevel.Null, applicationFormatter, "system.log")
newFileHandler := handler.NewFileHandler(level.Debug, level.Null, applicationFormatter, "system.log")
```

You could create your custom handler:

```go
customHandler := handler.New(loglevel.Debug, loglevel.Null, applicationFormatter, os.Stdout)
customHandler := handler.New(level.Debug, level.Null, applicationFormatter, os.Stdout)
```

It takes two additional arguments writer for standard messages and for error messages. Standard message logs till
Expand Down
98 changes: 49 additions & 49 deletions docs/architecture/diagrams/plantuml/class_diagram.plantuml
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ package pkg.logger {
package formatter {
interface Interface {
+ Template() : string
+ Format(message : string, loggerName : string, level : loglevel.LogLevel, colored : bool) : string
+ Format(message : string, loggerName : string, level : level.Level, colored : bool) : string
}

struct Formatter implements Interface {
~ template : string
+ IsEqual(anotherFormatter : *Formatter) : bool
+ EvaluatePreset(message : string, loggerName : string, level : loglevel.LogLevel) : map[string]string
+ EvaluatePreset(message : string, loggerName : string, level : level.Level) : map[string]string
+ Template() : string
+ Format(message : string, loggerName : string, level : loglevel.LogLevel, colored : bool) : string
+ Format(message : string, loggerName : string, level : level.Level, colored : bool) : string
}

class "<<module>>" {
~ logLevelColors : map[loglevel.LogLevel]string
~ logLevelColors : map[level.Level]string
~ resetColor : string
+ New(template : string) : *Formatter
}
Expand All @@ -27,66 +27,66 @@ package pkg.logger {
package handler {
interface Interface {
+ Writer() : io.Writer
+ FromLevel() loglevel.LogLevel
+ SetFromLevel(fromLevel loglevel.LogLevel)
+ ToLevel() loglevel.LogLevel
+ SetToLevel(toLevel loglevel.LogLevel)
+ FromLevel() level.Level
+ SetFromLevel(fromLevel level.Level)
+ ToLevel() level.Level
+ SetToLevel(toLevel level.Level)
+ Formatter() : formatter.Interface
+ Write(logName : string, level : loglevel.LogLevel, message : string, parameters : ...any)
+ Write(logName : string, level : level.Level, message : string, parameters : ...any)
}
struct Handler implements Interface {
~ fromLevel : loglevel.LogLevel
~ toLevel : loglevel.LogLevel
~ fromLevel : level.Level
~ toLevel : level.Level
~ formatter : formatter.Interface
~ writer : io.Writer
~ consoleSupportsANSIColors : func() bool
+ Writer() : io.Writer
+ FromLevel() : loglevel.LogLevel
+ SetLevel(level : loglevel.LogLevel)
+ ToLevel() : loglevel.LogLevel
+ SetToLevel(level : loglevel.LogLevel)
+ FromLevel() : level.Level
+ SetLevel(level : level.Level)
+ ToLevel() : level.Level
+ SetToLevel(level : level.Level)
+ Formatter() : formatter.Interface
+ Write(logName : string, level : loglevel.LogLevel, message : string, parameters : ...any)
+ Write(logName : string, level : level.Level, message : string, parameters : ...any)
}
class "<<module>>" {
~ osOpenFile : os.OpenFile(name : string, flag : int, perm : FileMode) : (*File, error)
~ osStdout : *File
~ osStderr : *File
+ New(fromLevel : loglevel.LogLevel, toLevel : loglevel.LogLevel, newFormatter : formatter.Interface, writer : io.Writer, errorWriter : io.Writer) : *Handler
+ NewConsoleHandler(fromLevel : loglevel.LogLevel, toLevel : loglevel.LogLevel, newFormatter : formatter.Interface) : *Handler
+ NewConsoleErrorHandler(fromLevel : loglevel.LogLevel, toLevel : loglevel.LogLevel, newFormatter : formatter.Interface) : *Handler
+ NewFileHandler(fromLevel : loglevel.LogLevel, toLevel : loglevel.LogLevel, newFormatter : formatter.Interface, file : string) : *Handler
+ New(fromLevel : level.Level, toLevel : level.Level, newFormatter : formatter.Interface, writer : io.Writer, errorWriter : io.Writer) : *Handler
+ NewConsoleHandler(fromLevel : level.Level, toLevel : level.Level, newFormatter : formatter.Interface) : *Handler
+ NewConsoleErrorHandler(fromLevel : level.Level, toLevel : level.Level, newFormatter : formatter.Interface) : *Handler
+ NewFileHandler(fromLevel : level.Level, toLevel : level.Level, newFormatter : formatter.Interface, file : string) : *Handler
~ consoleSupportsANSIColors() : bool
}

"<<module>>" ..> Handler : uses
}
package loglevel {
stereotype LogLevel <<int>> {
package level {
stereotype Level <<int>> {
+ String() : string
+ DigitRepresentation() : int
+ Next() : LogLevel
+ Previous() : LogLevel
+ Next() : Level
+ Previous() : Level
}
class "<<module>>" {
+ All : loglevel.LogLevel
+ Trace : loglevel.LogLevel
+ Debug : loglevel.LogLevel
+ Verbose : loglevel.LogLevel
+ Info : loglevel.LogLevel
+ Notice : loglevel.LogLevel
+ Warning : loglevel.LogLevel
+ Severe : loglevel.LogLevel
+ Error : loglevel.LogLevel
+ Alert : loglevel.LogLevel
+ Critical : loglevel.LogLevel
+ Emergency : loglevel.LogLevel
+ Null : loglevel.LogLevel
+ All : level.Level
+ Trace : level.Level
+ Debug : level.Level
+ Verbose : level.Level
+ Info : level.Level
+ Notice : level.Level
+ Warning : level.Level
+ Severe : level.Level
+ Error : level.Level
+ Alert : level.Level
+ Critical : level.Level
+ Emergency : level.Level
+ Null : level.Level
}
"<<module>>" ..> LogLevel : uses
"<<module>>" ..> Level : uses
}
interface baseLoggerInterface {
+ Log(level : loglevel.LogLevel, message : string, parameters : ...any)
+ Log(level : level.Level, message : string, parameters : ...any)
+ Name() : string
+ SetName(name : string)
+ Handlers() : []handler.Interface
Expand All @@ -96,7 +96,7 @@ package pkg.logger {
struct baseLogger implements baseLoggerInterface {
~ name : string
~ handlers : []handler.Interface
+ Log(level : loglevel.LogLevel, message : string, parameters : ...any)
+ Log(level : level.Level, message : string, parameters : ...any)
+ Name() : string
+ SetName(name : string)
+ Handlers() : []handler.Interface
Expand Down Expand Up @@ -139,31 +139,31 @@ package pkg.logger {
+ Emergency(message : string, parameters : ...any)
}
struct Configuration {
~ fromLevel : loglevel.LogLevel
~ toLevel : loglevel.LogLevel
~ fromLevel : level.Level
~ toLevel : level.Level
~ template : string
~ file : string
~ name : string
}
stereotype Option <<func(*Configuration)>> {}
class "<<module>>" {
~ rootLogger : *Logger
~ fromLevel : loglevel.LogLevel
~ toLevel : loglevel.LogLevel
~ fromLevel : level.Level
~ toLevel : level.Level
~ template : string
~ init()
+ New(name : string) : *Logger
+ WithFromLevel(fromLevel : loglevel.LogLevel) : Option
+ WithToLevel(toLevel : loglevel.LogLevel) : Option
+ WithFromLevel(fromLevel : level.Level) : Option
+ WithToLevel(toLevel : level.Level) : Option
+ WithTemplate(template : string) : Option
+ WithFile(file : string) : Option
+ WithName(name : string) : Option
+ NewConfiguration(options : ...Option) : *Configuration
+ Configure(configuration : *Configuration)
+ Name() : string
+ Template() : string
+ FromLevel() : loglevel.LogLevel
+ ToLevel() : loglevel.LogLevel
+ FromLevel() : level.Level
+ ToLevel() : level.Level
+ Trace(message : string, parameters : ...any)
+ Debug(message : string, parameters : ...any)
+ Verbose(message : string, parameters : ...any)
Expand All @@ -184,7 +184,7 @@ package pkg.logger {
Option ..> Configuration : uses
}

pkg.logger.handler.Handler *-- pkg.logger.loglevel.LogLevel : contains
pkg.logger.handler.Handler *-- pkg.logger.level.Level : contains
pkg.logger.handler.Handler *-- pkg.logger.formatter.Interface : contains
pkg.logger.baseLogger *-- "0..*" pkg.logger.handler.Interface : contains

Expand Down
Binary file modified docs/architecture/diagrams/png/class_diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading