echozap

README

echozap - BerryPay Public Fork

Middleware for Golang Echo framework that provides integration with Uber´s Zap logging library for logging HTTP requests.

Pre-requisites

• Go with Go modules enabled.
• Echo v4
• Zap

Usage

package main

import (
	"net/http"

	"github.com/berrypay/echozap"
	"github.com/labstack/echo/v4"
	"go.uber.org/zap"
)

func main() {
	e := echo.New()

	zapLogger, _ := zap.NewProduction()

	e.Use(echozap.ZapLogger(zapLogger))

	e.GET("/", func(c echo.Context) error {
		return c.String(http.StatusOK, "Hello, World!")
	})
	e.Logger.Fatal(e.Start(":1323"))
}

Logged details

The following information is logged:

• Status Code
• Time
• Uri
• Method
• Hostname
• Remote IP Address

Configuration

Customization can be made on 2 configurable items:

1. Skipper: skip logging based on the given condition
2. IncludeHeader: add custom log field based on the provided list of header keys

Usage:

package main

import (
	"net/http"

	"github.com/berrypay/echozap"
	"github.com/labstack/echo/v4"
	"go.uber.org/zap"
)

func main() {
	e := echo.New()

	zapLogger, _ := zap.NewProduction()

	e.Use(echozap.ZapLoggerWithConfig(zapLogger, echozap.ZapLoggerConfig{
        Skipper: nil,
		IncludeHeader: []string{
			echo.HeaderXRequestID,
		},
	}))

	e.GET("/", func(c echo.Context) error {
		return c.String(http.StatusOK, "Hello, World!")
	})
	e.Logger.Fatal(e.Start(":1323"))
}

Todo

• Add more customization options.

🤝 Contributing

Contributions, issues and feature requests are welcome!

Show your support

If this project have been useful for you, I would be grateful to have your support.

Give a ⭐️ to the project, or just:

Author

👤 Bruno Paz

• Website: https://github.com/brpaz
• Github: @brpaz

👤 Sallehuddin Abdul Latif

• Website: https://www.berrypay.com](https://www.berrypay.com)
• Github: @salleh @BerryPay

📝 License

Copyright © 2019 Bruno Paz. Copyright © 2023 Sallehuddin Abdul Latif

This project is MIT licensed.

Documentation

Index

• Variables
• func DefaultSkipper(echo.Context) bool
• func ZapLogger(log *zap.Logger) echo.MiddlewareFunc
• func ZapLoggerWithConfig(log *zap.Logger, config ZapLoggerConfig) echo.MiddlewareFunc
• type Skipper
• type ZapLoggerConfig

Variables

var (
	// DefaultZapLoggerConfig is the default ZapLogger middleware config.
	DefaultZapLoggerConfig = ZapLoggerConfig{
		Skipper:       DefaultSkipper,
		IncludeHeader: nil,
	}
)

Functions

func DefaultSkipper

func DefaultSkipper(echo.Context) bool

DefaultSkipper returns false which processes the middleware

func ZapLogger

func ZapLogger(log *zap.Logger) echo.MiddlewareFunc

ZapLogger is a middleware and zap to provide an "access log" like logging for each request.

func ZapLoggerWithConfig

func ZapLoggerWithConfig(log *zap.Logger, config ZapLoggerConfig) echo.MiddlewareFunc

ZapLoggerWithConfig is a middleware (with configuration) and zap to provide an "access log" like logging for each request.

Types

type Skipper

type Skipper func(c echo.Context) bool

type ZapLoggerConfig

type ZapLoggerConfig struct {
	// Skipper defines a function to skip middleware
	Skipper Skipper
	// IncludeRequestId
	IncludeHeader []string
}

ZapLoggerConfig defines the config for ZapLogger middleware