Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance Logger Middleware Documentation with Detailed Configuration Examples #2665

Open
3 tasks
lscannon12 opened this issue Jul 30, 2024 · 2 comments
Open
3 tasks

Comments

@lscannon12
Copy link

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

@ygxiaobai111
Copy link

Can I take this issue?

@aldas
Copy link
Contributor

aldas commented Dec 29, 2024

@ygxiaobai111 yes,

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants