logger

README

Middleware information

This folder contains a middleware for the build'n Iris logger but for the requests.

How to use

package main

import (
	"github.com/kataras/iris"
	"github.com/kataras/iris/middleware/logger"
)

func main() {

	iris.UseFunc(logger.Default())
	// or iris.Use(logger.DefaultHandler())
	// or iris.UseFunc(iris.HandlerFunc(logger.DefaultHandler())
	// or iris.Get("/", logger.Default(), func (ctx *iris.Context){})
	// or iris.Get("/", iris.HandlerFunc(logger.DefaultHandler()), func (ctx *iris.Context){})

	// Custom settings:
	// ...
	// iris.UseFunc(logger.Custom(writer io.Writer, prefix string, flag int))
	// and so on...

	// Custom options:
	// ...
	// iris.UseFunc(logger.Default(logger.Options{IP:false}))  // don't log the ip
	// or iris.UseFunc(logger.Custom(writer io.Writer, prefix string, flag int, logger.Options{IP:false}))
	// and so on...

	iris.Get("/", func(ctx *iris.Context) {
		ctx.Write("hello")
	})

	iris.Get("/1", func(ctx *iris.Context) {
		ctx.Write("hello")
	})

	iris.Get("/3", func(ctx *iris.Context) {
		ctx.Write("hello")
	})

	// IF YOU WANT LOGGER TO LOGS THE HTTP ERRORS ALSO THEN:
	// FUTURE: iris.OnError(404, logger.Default(logger.Options{Latency: false}))

	// NOW:
	errorLogger := logger.Default(logger.Options{Latency: false}) //here we just disable to log the latency, no need for error pages I think
	// yes we have options look at the logger.Options inside middleware/logger.go
	iris.OnError(404, func(ctx *iris.Context) {
		errorLogger.Serve(ctx)
		ctx.Write("My Custom 404 error page ")
	})
	//

	println("Server is running at :80")
	iris.Listen(":80")

}

Documentation

Index

• func Custom(loggerCfg config.Logger, options ...Options) iris.HandlerFunc
• func CustomHandler(loggerCfg config.Logger, options ...Options) iris.Handler
• func Default(options ...Options) iris.HandlerFunc
• func DefaultHandler(options ...Options) iris.Handler
• type Options
  • func DefaultOptions() Options

Functions

func Custom

func Custom(loggerCfg config.Logger, options ...Options) iris.HandlerFunc

Custom returns the logger middleware as HandlerFunc with customized settings accepts 3 parameters first parameter is the writer (io.Writer) second parameter is the prefix of which the message will follow up third parameter is the logger.Options

func CustomHandler

func CustomHandler(loggerCfg config.Logger, options ...Options) iris.Handler

CustomHandler returns the logger middleware with customized settings accepts 3 parameters first parameter is the writer (io.Writer) second parameter is the prefix of which the message will follow up third parameter is the logger.Options

func Default

func Default(options ...Options) iris.HandlerFunc

Default returns the logger middleware as HandlerFunc with the default settings

func DefaultHandler

func DefaultHandler(options ...Options) iris.Handler

DefaultHandler returns the logger middleware with the default settings

Types

type Options

type Options struct {
	Latency bool
	Status  bool
	IP      bool
	Method  bool
	Path    bool
}

Options are the options of the logger middlweare contains 5 bools Latency, Status, IP, Method, Path if set to true then these will print

func DefaultOptions

func DefaultOptions() Options

DefaultOptions returns an options which all properties are true