echo icon indicating copy to clipboard operation
echo copied to clipboard

Enhance Logger Middleware Documentation with Detailed Configuration Examples

Open lscannon12 opened this issue 1 year ago • 3 comments

Issue Description

The current documentation for the Logger middleware in the Echo framework is insufficient. It lacks detailed explanations of configuration options and comprehensive examples for various use cases. This makes it difficult for new users to fully understand and utilize the middleware’s capabilities.

Checklist

  • [ ] Dependencies installed
  • [ ] No typos
  • [ ] Searched existing issues and docs

Expected behaviour

The Logger middleware documentation should provide clear and detailed explanations for each configuration option. It should include comprehensive examples covering various use cases such as logging different request/response details, customizing log formats, and integrating with external logging services. Additionally, troubleshooting tips for common issues should be included.

Actual behaviour

The current documentation provides a basic example but lacks detailed explanations and comprehensive examples. This makes it challenging for users to understand how to fully utilize the Logger middleware.

Steps to reproduce

  1. Attempt to figure out Logger middleware using current examples
  2. Note the lack of detailed explanations, which may be a learning curve for new users.

Version/commit

Echo version: v4.12.0 Go version: 1.17.0 Operating System: MacOS

lscannon12 avatar Jul 30 '24 04:07 lscannon12

Can I take this issue?

ygxiaobai111 avatar Dec 29 '24 12:12 ygxiaobai111

@ygxiaobai111 yes,

Old Logger and new Request Logger middleware docs are here https://github.com/labstack/echox/blob/master/website/docs/middleware/logger.md

aldas avatar Dec 29 '24 13:12 aldas

@ygxiaobai111 yes,

Old Logger and new Request Logger middleware docs are here https://github.com/labstack/echox/blob/master/website/docs/middleware/logger.md

@aldas Okay. This is my second attempt to solve this kind of issue. I hope you can help me answer my questions if I have any doubts.

ygxiaobai111 avatar Dec 29 '24 13:12 ygxiaobai111