logger

README

Logger

A useful gas that used to log every request for the web applications built using Air.

Installation

Open your terminal and execute

$ go get github.com/air-gases/logger

done.

The only requirement is the Go, at least v1.13.

Usage

Create a file named main.go

package main

import (
	"github.com/air-gases/logger"
	"github.com/aofei/air"
)

func main() {
	a := air.Default
	a.DebugMode = true
	a.Pregases = []air.Gas{
		logger.Gas(logger.GasConfig{}),
	}
	a.GET("/", func(req *air.Request, res *air.Response) error {
		return res.WriteString("Go and see what your terminal outputs.")
	})
	a.Serve()
}

and run it

$ go run main.go

then visit http://localhost:8080.

Community

If you want to discuss Logger, or ask questions about it, simply post questions or ideas here.

Contributing

If you want to help build Logger, simply follow this to send pull requests here.

License

This project is licensed under the MIT License.

License can be found here.

Documentation

Index

• func Gas(gc GasConfig) air.Gas
• type GasConfig

Functions

func Gas

func Gas(gc GasConfig) air.Gas

Gas returns an `air.Gas` that is used to log ervery request based on the gc.

Types

type GasConfig

type GasConfig struct {
	Logger               *zerolog.Logger
	Message              string
	IncludeClientAddress bool

	Skippable func(*air.Request, *air.Response) bool
}

GasConfig is a set of configurations for the `Gas`.