Follow

Follow

Log requests and responses in the Go-echo framework!

Maheshwar Ligade's photo
Maheshwar Ligade
·May 19, 2023·

3 min read

Play this article

Table of contents

  • Introduction
  • Middleware in Go Echo Framework
  • Logging Requests and Responses in Go Echo Framework
  • Customizing the Logger Middleware
  • Conclusion

Introduction

Logging is an essential aspect of web application development that helps developers debug and troubleshoot issues that may arise during development or in production. In Go Echo framework, logging can be used to monitor incoming requests and outgoing responses to help identify potential errors, bottlenecks, or security vulnerabilities.

This article will demonstrate how to log requests and responses in Go Echo framework using middleware.

Middleware in Go Echo Framework

Middleware is a popular design pattern used in web frameworks to add additional functionality to the request/response cycle. Middleware is essentially a function that takes a request and returns a response. In Go Echo framework, middleware can be used to perform tasks such as authentication, logging, error handling, and more.

Logging Requests and Responses in Go Echo Framework

To log requests and responses in Go Echo framework, we can create a middleware function that logs the incoming request and outgoing responses. Here's an example:

package main

import (
    "fmt"
    "github.com/labstack/echo/v4"
    "github.com/labstack/echo/v4/middleware"
    "log"
    "net/http"
    "os"
)

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

    // Middleware
    e.Use(middleware.Logger())

    // Routes
    e.GET("/", hello)

    // Start server
    port := os.Getenv("PORT")
    if port == "" {
        port = "8080"
    }
    e.Logger.Fatal(e.Start(":" + port))
}

func hello(c echo.Context) error {
    return c.String(http.StatusOK, "Hello, World!")
}

In this example, we use the middleware.Logger() middleware function to log incoming requests and outgoing responses. The middleware.Logger() function logs the request method, status code, response time, and request URI.

Customizing the Logger Middleware

The default logger middleware provided by Go Echo framework is helpful for simple logging, but it can be customized to meet specific requirements. Here's an example of how to customize the logger middleware:

func loggerMiddleware(next echo.HandlerFunc) echo.HandlerFunc {
    return func(c echo.Context) error {
        // Log incoming request
        log.Printf("Incoming Request: %s %s", c.Request().Method, c.Request().URL.String())

        // Call next handler
        if err := next(c); err != nil {
            c.Error(err)
        }

        // Log outgoing response
        log.Printf("Outgoing Response: %d %s", c.Response().Status, http.StatusText(c.Response().Status))

        return nil
    }
}

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

    // Middleware
    e.Use(loggerMiddleware)

    // Routes
    e.GET("/", hello)

    // Start server
    port := os.Getenv("PORT")
    if port == "" {
        port = "8080"
    }
    e.Logger.Fatal(e.Start(":" + port))
}

func hello(c echo.Context) error {
    return c.String(http.StatusOK, "Hello, World!")
}

In this example, we define our custom logger middleware that logs incoming request and outgoing response. The loggerMiddleware() function takes the next handler function as an argument, which is called after logging the incoming request. The next function is called after the logging is done to continue the request/response cycle. After the next function is called, the logger middleware logs the outgoing response.

Conclusion

Logging requests and responses is a crucial aspect of web application development, as it helps developers identify and troubleshoot issues that may arise. In Go Echo framework, logging can be achieved using middleware functions. In this article, we demonstrated how to log requests and responses using the built-in logger middleware and how to customize it.

I hope this helps, you!!

More such articles:

https://medium.com/techwasti

https://www.youtube.com/channel/UCiTaHm1AYqMS4F4L9zyO7qA

https://www.techwasti.com/

\==========================**=========================

If this article adds any value to you then please clap and comment.

Let’s connect on Stackoverflow, LinkedIn, & Twitter.

Did you find this article valuable?

Support techwasti by becoming a sponsor. Any amount is appreciated!

See recent sponsors Learn more about Hashnode Sponsors
 
Share this