logger

package
v0.0.0-...-aeb31df Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 2, 2016 License: BSD-3-Clause Imports: 4 Imported by: 0

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

Overview

Copyright (c) 2016, Gerasimos Maropoulos All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  1. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  1. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER AND CONTRIBUTOR, GERASIMOS MAROPOULOS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Custom

func Custom(writer io.Writer, prefix string, flag int, 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(writer io.Writer, prefix string, flag int, 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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL