Logging

Introduction

In order to understand the running status of the application, Goravel provides a powerful log service that can record log messages and system errors to a file or other channels through facades.Log().

Configuration

To configure various log channels, custom configurations can be made in config/logging.go.

Goravel uses stack channel to record logs by default, stack allows logs to be forwarded to multiple channels.

The print configuration in single and daily drivers can control log output to the console.

Available channel drivers

NameDescription
stackAllow multiple channels
singleSingle log file
dailyOne log file per day
customCustom drive

Inject Context

facades.Log().WithContext(ctx)

Write log messages

facades.Log().Debug(message)
facades.Log().Debugf(message, args)
facades.Log().Info(message)
facades.Log().Infof(message, args)
facades.Log().Warning(message)
facades.Log().Warningf(message, args)
facades.Log().Error(message)
facades.Log().Errorf(message, args)
facades.Log().Fatal(message)
facades.Log().Fatalf(message, args)
facades.Log().Panic(message)
facades.Log().Panicf(message, args)

Write to a specific channel

Sometimes, you may want to record messages to a channel other than the application's default channel:

facades.Log().Channel("single").Info(message)

If you want to write to multiple channels at the same time, you can use the Stack method:

facades.Log().Stack([]string{"single", "slack"}).Info(message)

Chain Methods

Goravel provides convenient chain methods, that make it easy to insert more useful information into the log:

facades.Log().User("John").Debug(message)
MethodAction
CodeSet a code or slug that describes the log.
HintSet a hint for faster debugging.
InSet the feature category or domain in which the log entry is relevant.
OwnerUseful for alerting purposes.
RequestSupplies a http.Request.
ResponseSupplies a http.Response.
TagsAdd multiple tags, describing the feature returning an error.
UserSet the user associated with the log entry.
WithAdd key-value pairs to the context of the log entry.
WithTraceAdd stack information to the log entry.

Create a custom channel

If you want to define a completely custom channel, you can specify the custom driver type in the config/logging.go configuration file. Then include a via option to implement a framework\contracts\log\Logger structure:

// config/logging.go
"custom": map[string]interface{}{
    "driver": "custom",
    "via":    &CustomTest{},
},

Implement Driver

Implement framework\contracts\log\Logger interface.

// framework/contracts/log/Logger
package log

type Logger interface {
  // Handle pass channel config path here
  Handle(channel string) (Hook, error)
}

files can be stored in the app/extensions folder (modifiable). Example:

package extensions

import (
  "fmt"

  "github.com/goravel/framework/contracts/log"
)

type Logger struct {
}

// Handle pass channel config path here
func (logger *Logger) Handle(channel string) (log.Hook, error) {
  return &Hook{}, nil
}

type Hook struct {
}

// Levels monitoring level
func (h *Hook) Levels() []log.Level {
  return []log.Level{
    log.DebugLevel,
    log.InfoLevel,
    log.WarningLevel,
    log.ErrorLevel,
    log.FatalLevel,
    log.PanicLevel,
  }
}

// Fire execute logic when trigger
func (h *Hook) Fire(entry log.Entry) error {
  fmt.Printf("context=%v level=%v time=%v message=%s", entry.Context(), entry.Level(), entry.Time(), entry.Message())

  return nil
}