https://github.com/elafarge/gin-http-logger

An HTTP access log forwarder for the Gin-Gonic web framework.
https://github.com/elafarge/gin-http-logger

fluentd gin gin-gonic http https logging middleware

Last synced: 2 months ago
JSON representation

An HTTP access log forwarder for the Gin-Gonic web framework.

• Host: GitHub
• URL: https://github.com/elafarge/gin-http-logger
• Owner: elafarge
• Created: 2017-01-17T10:23:45.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-27T17:32:37.000Z (about 7 years ago)
• Last Synced: 2024-09-30T07:21:58.690Z (3 months ago)
• Topics: fluentd, gin, gin-gonic, http, https, logging, middleware
• Language: Go
• Homepage:
• Size: 24.4 KB
• Stars: 6
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Gin-Gonic HTTP log forwarder

============================

A Gin-Gonic middleware forwarding access logs over HTTP (in JSON). It can be

used for instance to forward all your requests logs to a Fluentd HTTP listener.

Features

--------

 * Non blocking: heavy calls made in a goroutine separated from the GIN handler

   one.

 * Possible to log the request & response bodies all the time, when the handler

   returns an error code (4xx, 5xx) or never

 * Memory efficient: uses the standard `io` library abstractions to limit

   what's loaded in memory, body logs are truncated to 10000 bytes by default,

   in case of connection failure with the HTTP endpoint, no more than 1000 logs

   will be kept in memory. These values can be tweaked to your liking.

 * Lightweight but complete

Usage

-----

Like any other Gin-Gonic middleware:

```golang

import (

  // ...

  httpLogger "github.com/elafarge/gin-http-logger"

  "github.com/gin-gonic/gin"

  // ...

)

// ...

  r := gin.Default()

	httpLoggerConf := httpLogger.FluentdLoggerConfig{

		Host:           "localhost",

		Port:           13713,

		Env:            "etienne-kubernetes",

		Tag:            "gin.requests",

		BodyLogPolicy:  httpLogger.LOG_BODIES_ON_ERROR,

		MaxBodyLogSize: 50,

		DropSize:       5,

		RetryInterval:  5,

	}

	r.Use(httpLogger.New(httpLoggerConf))

```

### Compatible with

 * FluentD (tested)

### Author

 * Étienne Lafarge